IPXC_PageText::GetChars Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 3: | Line 3: | ||
{{#customTitle:IPXC_PageText::GetChars Method}} | {{#customTitle:IPXC_PageText::GetChars Method}} | ||
{{#parentPage:PXV:IPXC_PageText#Methods|GetChars|method}} | {{#parentPage:PXV:IPXC_PageText#Methods|GetChars|method}} | ||
| − | |||
{{ToReview}} | {{ToReview}} | ||
| − | + | Gets given number of characters from the page text. | |
== Syntax == | == Syntax == | ||
<pre class="brush:cpp;gutter:false">HRESULT GetChars([in] ULONG nFirstCharIndex, | <pre class="brush:cpp;gutter:false">HRESULT GetChars([in] ULONG nFirstCharIndex, | ||
[in] ULONG nCharsCount, | [in] ULONG nCharsCount, | ||
| − | [out, retval] BSTR* | + | [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. |
| − | ; | + | ;sChars |
| − | :[out, retval] Pointer to BSTR. | + | :[out, retval] Pointer to BSTR containing the resulting characters from the page text. |
== Return Value == | == Return Value == | ||
Latest revision as of 22: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.
