IPXC_Page::GetText Method

Revision as of 05:46, 20 May 2015

Gets page text using text options.

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

IPXC_Page.