IPXV_Document::GetPlainText Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
m (Automatic page editing by robot)
Line 5: Line 5:
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT GetPlainText([in] ULONG nPageIndex, [in, optional] ULONG nFirstCharIndex, [in, optional] ULONG nCharsCount, [out, retval] BSTR* ppText);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT GetPlainText([in] ULONG nPageIndex, [in, defaultvalue(0)] ULONG nFirstCharIndex, [in, defaultvalue(-1)] ULONG nCharsCount, [out, retval] BSTR* ppText);</pre>
  
 
== Parameters ==
 
== Parameters ==
Line 11: Line 11:
 
:[in]  Value of ULONG.
 
:[in]  Value of ULONG.
 
;''nFirstCharIndex''
 
;''nFirstCharIndex''
:[in, optional]  Value of ULONG.
+
:[in, defaultvalue(0)]  Value of ULONG.
 
;''nCharsCount''
 
;''nCharsCount''
:[in, optional]  Value of ULONG.
+
:[in, defaultvalue(-1)]  Value of ULONG.
 
;''ppText''
 
;''ppText''
 
:[out, retval]  Pointer to BSTR.
 
:[out, retval]  Pointer to BSTR.

Revision as of 00:55, 17 April 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* ppText);

Parameters

nPageIndex
[in] Value of ULONG.
nFirstCharIndex
[in, defaultvalue(0)] Value of ULONG.
nCharsCount
[in, defaultvalue(-1)] Value of ULONG.
ppText
[out, retval] Pointer to BSTR.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

See also IPXV_Document.