IPXC_PageText::GetChars Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_PageText::GetChars Method}}
 
{{#customTitle:IPXC_PageText::GetChars Method}}
 +
{{#parentPage:PXV:IPXC_PageText#Methods|GetChars|method}}
 +
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Gets given number of characters from the page text.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT GetChars([in] ULONG nFirstCharIndex, [in] ULONG nCharsCount, [out, retval] BSTR* ppChars);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT GetChars([in]           ULONG nFirstCharIndex,
 +
                [in]           ULONG nCharsCount,
 +
                [out, retval] BSTR* sChars);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''nFirstCharIndex''
+
;nFirstCharIndex
:[in]  Value of ULONG.
+
:[in]  Value of ULONG containing the starting character index.
;''nCharsCount''
+
;nCharsCount
:[in]  Value of ULONG.
+
:[in]  Value of ULONG containing the number of characters that should be extracted.
;''ppChars''
+
;sChars
:[out, retval]  Pointer to BSTR.
+
:[out, retval]  Pointer to BSTR containing the resulting characters from the page text.
  
 
== Return Value ==
 
== Return Value ==
Line 19: Line 24:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXC_PageText|IPXC_PageText]].
+
[[PXV:IPXC_PageText|IPXC_PageText]]

Latest revision as of 23:40, 12 May 2016


Gets given number of characters from the page text.

Syntax

HRESULT GetChars([in]           ULONG  nFirstCharIndex,
                 [in]           ULONG  nCharsCount,
                 [out, retval]  BSTR*  sChars);

Parameters

nFirstCharIndex
[in] Value of ULONG containing the starting character index.
nCharsCount
[in] Value of ULONG containing the number of characters that should be extracted.
sChars
[out, retval] Pointer to BSTR containing the resulting characters from the page text.

Return Value

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

See Also

IPXC_PageText