IPXC_PageText::GetChars Method
From PDF XChange PDF SDK
| Line 14: | Line 14: | ||
== Parameters == | == Parameters == | ||
;nFirstCharIndex | ;nFirstCharIndex | ||
| − | :[in] Value of ULONG containing the starting character. | + | :[in] Value of ULONG containing the starting character index. |
;nCharsCount | ;nCharsCount | ||
:[in] Value of ULONG containing the number of characters that should be extracted. | :[in] Value of ULONG containing the number of characters that should be extracted. | ||
;sChars | ;sChars | ||
| − | :[out, retval] Pointer to BSTR containing resulting characters from the page text. | + | :[out, retval] Pointer to BSTR containing the resulting characters from the page text. |
== Return Value == | == Return Value == | ||
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.
