IPXV_SearchEntryItem::GetDispTextRange Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| (7 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IPXV_SearchEntryItem::GetDispTextRange Method}} | {{#customTitle:IPXV_SearchEntryItem::GetDispTextRange Method}} | ||
| − | {{#parentPage:PXV:IPXV_SearchEntryItem|GetDispTextRange | + | {{#parentPage:PXV:IPXV_SearchEntryItem#Methods|GetDispTextRange|method}} |
| − | + | ||
{{ToReview}} | {{ToReview}} | ||
| − | The method | + | The method is used to get the Display Text Ranges by index that are used for highlighting the [[PXV:IPXV_SearchEntryItem_DispText|DispText]] in the Editors Search Pane. This method is optional and will be available when the PXV_SearchFlag_GetDispText flag is used. |
== Syntax == | == Syntax == | ||
<pre class="brush:cpp;gutter:false">HRESULT GetDispTextRange([in] ULONG nDispRangeIndex, | <pre class="brush:cpp;gutter:false">HRESULT GetDispTextRange([in] ULONG nDispRangeIndex, | ||
| − | [out] ULONG* | + | [out] ULONG* nFirstCharIndex, |
| − | [out] ULONG* | + | [out] ULONG* nCharsCount, |
| − | [out] ULONG* | + | [out] ULONG* nWordIndex);</pre> |
== Parameters == | == Parameters == | ||
;nDispRangeIndex | ;nDispRangeIndex | ||
| − | :[in] Value of ULONG. | + | :[in] Value of ULONG containing the index of the range. |
| − | ; | + | ;nFirstCharIndex |
| − | :[out] Pointer to ULONG. | + | :[out] Pointer to ULONG containing the index of the first character. |
| − | ; | + | ;nCharsCount |
| − | :[out] Pointer to ULONG. | + | :[out] Pointer to ULONG containing the number of characters. |
| − | ; | + | ;nWordIndex |
| − | :[out] Pointer to ULONG. | + | :[out] Pointer to ULONG containing the index of the word. |
== Return Value == | == Return Value == | ||
| Line 27: | Line 27: | ||
== See Also == | == See Also == | ||
| − | + | [[PXV:IPXV_SearchEntryItem|IPXV_SearchEntryItem]] | |
Latest revision as of 01:55, 20 January 2017
The method is used to get the Display Text Ranges by index that are used for highlighting the DispText in the Editors Search Pane. This method is optional and will be available when the PXV_SearchFlag_GetDispText flag is used.
Syntax
HRESULT GetDispTextRange([in] ULONG nDispRangeIndex,
[out] ULONG* nFirstCharIndex,
[out] ULONG* nCharsCount,
[out] ULONG* nWordIndex);
Parameters
- nDispRangeIndex
- [in] Value of ULONG containing the index of the range.
- nFirstCharIndex
- [out] Pointer to ULONG containing the index of the first character.
- nCharsCount
- [out] Pointer to ULONG containing the number of characters.
- nWordIndex
- [out] Pointer to ULONG containing the index of the word.
Return Value
Returns S_OK if operation was successful or error code in other cases.
