IPXV_Document::GetPlainText Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
Line 9: | Line 9: | ||
== Syntax == | == Syntax == | ||
− | <pre class="brush:cpp;gutter:false">HRESULT GetPlainText([in] ULONG | + | <pre class="brush:cpp;gutter:false">HRESULT GetPlainText([in] ULONG PageIndex, |
− | [in, defaultvalue(0)] ULONG | + | [in, defaultvalue(0)] ULONG FirstCharIndex, |
− | [in, defaultvalue(-1)] ULONG | + | [in, defaultvalue(-1)] ULONG CharsCount, |
− | [out, retval] BSTR* | + | [out, retval] BSTR* Text);</pre> |
== Parameters == | == Parameters == | ||
− | ; | + | ;PageIndex |
:[in] Value of ULONG. | :[in] Value of ULONG. | ||
− | ; | + | ;FirstCharIndex |
:[in, defaultvalue(0)] Value of ULONG. | :[in, defaultvalue(0)] Value of ULONG. | ||
− | ; | + | ;CharsCount |
:[in, defaultvalue(-1)] Value of ULONG. | :[in, defaultvalue(-1)] Value of ULONG. | ||
− | ; | + | ;Text |
:[out, retval] Pointer to BSTR. | :[out, retval] Pointer to BSTR. | ||
Revision as of 07:28, 12 June 2015
The method of interface of PDF-XChange Editor SDK.
Syntax
HRESULT GetPlainText([in] ULONG PageIndex, [in, defaultvalue(0)] ULONG FirstCharIndex, [in, defaultvalue(-1)] ULONG CharsCount, [out, retval] BSTR* Text);
Parameters
- PageIndex
- [in] Value of ULONG.
- FirstCharIndex
- [in, defaultvalue(0)] Value of ULONG.
- CharsCount
- [in, defaultvalue(-1)] Value of ULONG.
- Text
- [out, retval] Pointer to BSTR.
Return Value
Returns S_OK if operation was successful or error code in other cases.