IPXC_Page::GetText Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| Line 8: | Line 8: | ||
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT GetText([in] IPXC_GetPageTextOptions* | + | <pre class="brush:cpp;gutter:false">HRESULT GetText([in] IPXC_GetPageTextOptions* Options, |
| − | [in, defaultvalue(0)] VARIANT_BOOL | + | [in, defaultvalue(0)] VARIANT_BOOL NoCache, |
| − | [out, retval] IPXC_PageText** | + | [out, retval] IPXC_PageText** Text);</pre> |
== Parameters == | == Parameters == | ||
| − | ; | + | ;Options |
:[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. | :[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. | ||
| − | ; | + | ;NoCache |
:[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. | :[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. | ||
| − | ; | + | ;Text |
:[out, retval] Pointer to [[PXV:IPXC_PageText|IPXC_PageText]] containing the resulting page text. | :[out, retval] Pointer to [[PXV:IPXC_PageText|IPXC_PageText]] containing the resulting page text. | ||
Revision as of 07:08, 12 June 2015
Gets page text using text options.
Syntax
HRESULT GetText([in] IPXC_GetPageTextOptions* Options,
[in, defaultvalue(0)] VARIANT_BOOL NoCache,
[out, retval] IPXC_PageText** Text);
Parameters
- Options
- [in] Pointer to IPXC_GetPageTextOptions containing predefined text options. If this parameter is NULL the default page options will be used instead.
- NoCache
- [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.
- Text
- [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.
