IUIX_Combo::FindItemByText Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 2: Line 2:
 
{{#customTitle:IUIX_Combo::FindItemByText Method}}
 
{{#customTitle:IUIX_Combo::FindItemByText Method}}
 
{{#parentPage:PXV:IUIX_Combo|FindItemByText Method|method}}
 
{{#parentPage:PXV:IUIX_Combo|FindItemByText Method|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Returns ''index'' of an item with a required ''text''.
  
 
== Syntax ==
 
== Syntax ==
Line 14: Line 13:
 
== Parameters ==
 
== Parameters ==
 
;pText
 
;pText
:[in]  Value of BSTR.
+
:[in]  BSTR value of '''text''' to search for.
 
;nFlags
 
;nFlags
:[in, defaultvalue(0)]  Value of LONG.
+
:[in, defaultvalue(0)]  Search flags. See [[PXV:UIX_FindItemByTextFlags|UIX_FindItemByTextFlags]] for a full list of available search flags.
 
;pIndex
 
;pIndex
:[out, retval] Pointer to LONG.
+
:[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 ==
 
== Return Value ==

Revision as of 08:13, 7 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)] Search flags. 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.