IPXC_Page::GetText Method
From PDF XChange PDF SDK
(Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| (11 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXC_Page::GetText Method}} | {{#customTitle:IPXC_Page::GetText Method}} | ||
| + | {{#parentPage:PXV:IPXC_Page#Methods|GetText|method}} | ||
| + | {{ToReview}} | ||
| − | + | Gets [[PXV:IPXC_PageText|page text]] using [[PXV:IPXC_GetPageTextOptions|text options]]. | |
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT GetText([in] IPXC_GetPageTextOptions* pOptions, [in, | + | <pre class="brush:cpp;gutter:false">HRESULT GetText([in] IPXC_GetPageTextOptions* pOptions, |
| + | [in, defaultvalue(0)] VARIANT_BOOL bNoCache, | ||
| + | [out, retval] IPXC_PageText** pText);</pre> | ||
== Parameters == | == Parameters == | ||
| − | ; | + | ;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 |
| − | :[in, | + | :[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]]. | + | :[out, retval] Pointer to [[PXV:IPXC_PageText|IPXC_PageText]] containing the resulting page text. |
== Return Value == | == Return Value == | ||
| Line 19: | Line 24: | ||
== See Also == | == See Also == | ||
| − | + | [[PXV:IPXC_Page|IPXC_Page]] | |
Latest revision as of 03: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.
