IPXC_Page::GetText Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXC_Page::GetText Method}} | {{#customTitle:IPXC_Page::GetText Method}} | ||
| − | {{#parentPage:PXV:IPXC_Page|GetText | + | {{#parentPage:PXV:IPXC_Page#Methods|GetText|method}} |
{{ToReview}} | {{ToReview}} | ||
| Line 10: | Line 10: | ||
<pre class="brush:cpp;gutter:false">HRESULT GetText([in] IPXC_GetPageTextOptions* pOptions, | <pre class="brush:cpp;gutter:false">HRESULT GetText([in] IPXC_GetPageTextOptions* pOptions, | ||
[in, defaultvalue(0)] VARIANT_BOOL bNoCache, | [in, defaultvalue(0)] VARIANT_BOOL bNoCache, | ||
| − | [out, retval] IPXC_PageText** | + | [out, retval] IPXC_PageText** pText);</pre> |
== Parameters == | == Parameters == | ||
| Line 17: | Line 17: | ||
;bNoCache | ;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. | :[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. | ||
| − | ; | + | ;pText |
:[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. | ||
| Line 24: | Line 24: | ||
== See Also == | == See Also == | ||
| − | [[PXV:IPXC_Page|IPXC_Page]] | + | [[PXV:IPXC_Page|IPXC_Page]] |
Latest revision as of 02:32, 15 June 2015
Gets page text using text options.
Syntax
HRESULT GetText([in] IPXC_GetPageTextOptions* pOptions,
[in, defaultvalue(0)] VARIANT_BOOL bNoCache,
[out, retval] IPXC_PageText** pText);
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.
- pText
- [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.
