IUIX_Combo::SelItemByText Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 2: | Line 2: | ||
{{#customTitle:IUIX_Combo::SelItemByText Method}} | {{#customTitle:IUIX_Combo::SelItemByText Method}} | ||
{{#parentPage:PXV:IUIX_Combo|SelItemByText Method|method}} | {{#parentPage:PXV:IUIX_Combo|SelItemByText Method|method}} | ||
| − | |||
{{ToReview}} | {{ToReview}} | ||
| − | + | Selects an item with a required ''text''. | |
== Syntax == | == Syntax == | ||
| Line 14: | Line 13: | ||
== Parameters == | == Parameters == | ||
;pText | ;pText | ||
| − | :[in] | + | :[in] text of an item that is to be selected. |
;nFlags | ;nFlags | ||
| − | :[in, defaultvalue(0)] | + | :[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, defaultvalue(NULL)] | + | :[out, retval, defaultvalue(NULL)] returns value of selected item index. Returns -1 if no items with given text search parameters were found. If there is more than one item that matches given text search parameters, an item which is the first of them in a list will be selected. |
== Return Value == | == Return Value == | ||
| Line 24: | Line 23: | ||
== See Also == | == See Also == | ||
| − | See also [[PXV:IUIX_Combo|IUIX_Combo]]. | + | See also [[PXV:IUIX_Combo|IUIX_Combo]], [[PXV:UIX_FindItemByTextFlags|UIX_FindItemByTextFlags]]. |
Revision as of 07:45, 8 May 2015
Selects an item with a required text.
Contents
Syntax
HRESULT SelItemByText([in] BSTR pText,
[in, defaultvalue(0)] LONG nFlags,
[out, retval, defaultvalue(NULL)] LONG* pIndex);
Parameters
- pText
- [in] text of an item that is to be selected.
- nFlags
- [in, defaultvalue(0)] Specifies parameters of text search. See UIX_FindItemByTextFlags for a full list of available search flags.
- pIndex
- [out, retval, defaultvalue(NULL)] returns value of selected item index. Returns -1 if no items with given text search parameters were found. If there is more than one item that matches given text search parameters, an item which is the first of them in a list will be selected.
Return Value
Returns S_OK if operation was successful or error code in other cases.
See Also
See also IUIX_Combo, UIX_FindItemByTextFlags.
