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 nPageIndex, |
− | [in, defaultvalue(0)] ULONG | + | [in, defaultvalue(0)] ULONG nFirstCharIndex, |
− | [in, defaultvalue(-1)] ULONG | + | [in, defaultvalue(-1)] ULONG nCharsCount, |
− | [out, retval] BSTR* | + | [out, retval] BSTR* sText);</pre> |
== Parameters == | == Parameters == | ||
− | ; | + | ;nPageIndex |
:[in] Value of ULONG. | :[in] Value of ULONG. | ||
− | ; | + | ;nFirstCharIndex |
:[in, defaultvalue(0)] Value of ULONG. | :[in, defaultvalue(0)] Value of ULONG. | ||
− | ; | + | ;nCharsCount |
:[in, defaultvalue(-1)] Value of ULONG. | :[in, defaultvalue(-1)] Value of ULONG. | ||
− | ; | + | ;sText |
:[out, retval] Pointer to BSTR. | :[out, retval] Pointer to BSTR. | ||
Latest revision as of 03:53, 15 June 2015
The method of interface of PDF-XChange Editor SDK.
Syntax
HRESULT GetPlainText([in] ULONG nPageIndex, [in, defaultvalue(0)] ULONG nFirstCharIndex, [in, defaultvalue(-1)] ULONG nCharsCount, [out, retval] BSTR* sText);
Parameters
- nPageIndex
- [in] Value of ULONG.
- nFirstCharIndex
- [in, defaultvalue(0)] Value of ULONG.
- nCharsCount
- [in, defaultvalue(-1)] Value of ULONG.
- sText
- [out, retval] Pointer to BSTR.
Return Value
Returns S_OK if operation was successful or error code in other cases.