IPXV_Document::GetPlainText Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
m (Automatic page editing by robot)
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXV_Document::GetPlainText Method}}
 
{{#customTitle:IPXV_Document::GetPlainText Method}}
 +
{{#parentPage:PXV:IPXV_Document#Methods|GetPlainText|method}}
 +
{{ToWrite}}
 +
{{ToReview}}
  
 
The method of interface of PDF-XChange Editor SDK.
 
The method of interface of PDF-XChange Editor SDK.
  
 
== 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* sText);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''nPageIndex''
+
;nPageIndex
 
:[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''
+
;sText
 
:[out, retval]  Pointer to BSTR.
 
:[out, retval]  Pointer to BSTR.
  
Line 21: Line 28:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXV_Document|IPXV_Document]].
+
[[PXV:IPXV_Document|IPXV_Document]]

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.

See Also

IPXV_Document