IPXV_SearchEntryItem::GetDispTextRange Method

From Tracker Software PDF SDK
Jump to: navigation, search


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.

See Also

IPXV_SearchEntryItem