IUIX_Combo::FindItemByText Method

From PDF XChange PDF SDK
Jump to: navigation, search
Line 15: Line 15:
 
:[in]  BSTR value of '''text''' to search for.
 
:[in]  BSTR value of '''text''' to search for.
 
;nFlags
 
;nFlags
:[in, defaultvalue(0)]  Search flags. See [[PXV:UIX_FindItemByTextFlags|UIX_FindItemByTextFlags]] for a full list of available search flags.
+
:[in, defaultvalue(0)]  Specifies parameters of text search. See [[PXV:UIX_FindItemByTextFlags|UIX_FindItemByTextFlags]] for a full list of available search flags.
 
;pIndex
 
;pIndex
 
:[out, retval] Returned value of found item index. Returns -1 if no items with given parameters were found. If there are more than one items found, index of the first of them in combo box list will be returned.
 
:[out, retval] Returned value of found item index. Returns -1 if no items with given parameters were found. If there are more than one items found, index of the first of them in combo box list will be returned.

Revision as of 08:39, 8 May 2015


Returns index of an item with a required text.

Syntax

HRESULT FindItemByText([in]                   BSTR   pText,
                       [in, defaultvalue(0)]  LONG   nFlags,
                       [out, retval]          LONG*  pIndex);

Parameters

pText
[in] BSTR value of text to search for.
nFlags
[in, defaultvalue(0)] Specifies parameters of text search. See UIX_FindItemByTextFlags for a full list of available search flags.
pIndex
[out, retval] Returned value of found item index. Returns -1 if no items with given parameters were found. If there are more than one items found, index of the first of them in combo box list will be returned.

Return Value

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

See Also

See also IUIX_Combo.