IPXC_Page::GetText Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 5: | Line 5: | ||
{{ToReview}} | {{ToReview}} | ||
| − | + | Gets [[PXV:IPXC_PageText|page text]] using [[PXV:IPXC_GetPageTextOptions|text options]]. | |
== Syntax == | == Syntax == | ||
| Line 14: | Line 14: | ||
== Parameters == | == Parameters == | ||
;pOptions | ;pOptions | ||
| − | :[in] Pointer to [[PXV:IPXC_GetPageTextOptions|IPXC_GetPageTextOptions]]. | + | :[in] Pointer to [[PXV:IPXC_GetPageTextOptions|IPXC_GetPageTextOptions]] containing predefined text options. If this parameter is NULL the default page options will be used instead. |
;bNoCache | ;bNoCache | ||
| − | :[in, defaultvalue(0)] | + | :[in, defaultvalue(0)] Choose whether the returned page text should be cached. The results of the text assembling are cached by default which speeds up the further usage of it. |
;ppText | ;ppText | ||
| − | :[out, retval] Pointer to [[PXV:IPXC_PageText|IPXC_PageText]]. | + | :[out, retval] Pointer to [[PXV:IPXC_PageText|IPXC_PageText]] containing the resulting page text. |
== Return Value == | == Return Value == | ||
Revision as of 05:48, 13 May 2015
Gets page text using text options.
Contents
Syntax
HRESULT GetText([in] IPXC_GetPageTextOptions* pOptions,
[in, defaultvalue(0)] VARIANT_BOOL bNoCache,
[out, retval] IPXC_PageText** ppText);
Parameters
- pOptions
- [in] Pointer to IPXC_GetPageTextOptions containing predefined text options. If this parameter is NULL the default page options will be used instead.
- bNoCache
- [in, defaultvalue(0)] Choose whether the returned page text should be cached. The results of the text assembling are cached by default which speeds up the further usage of it.
- ppText
- [out, retval] Pointer to IPXC_PageText containing the resulting page text.
Return Value
Returns S_OK if operation was successful or error code in other cases.
See Also
See also IPXC_Page.
