IUIX_Combo::SelItemByText Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| Line 8: | Line 8: | ||
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT SelItemByText([in] BSTR | + | <pre class="brush:cpp;gutter:false">HRESULT SelItemByText([in] BSTR sText, |
[in, defaultvalue(0)] LONG nFlags, | [in, defaultvalue(0)] LONG nFlags, | ||
| − | [out, retval, defaultvalue(NULL)] LONG* | + | [out, retval, defaultvalue(NULL)] LONG* nIndex);</pre> |
== Parameters == | == Parameters == | ||
| − | ; | + | ;sText |
:[in] text of an item that is to be selected. | :[in] text of an item that is to be selected. | ||
;nFlags | ;nFlags | ||
:[in, defaultvalue(0)] Specifies parameters of text search. 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. | ||
| − | ; | + | ;nIndex |
:[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. | :[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. | ||
Revision as of 03:17, 15 June 2015
Selects an item with a required text.
Syntax
HRESULT SelItemByText([in] BSTR sText,
[in, defaultvalue(0)] LONG nFlags,
[out, retval, defaultvalue(NULL)] LONG* nIndex);
Parameters
- sText
- [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.
- nIndex
- [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.
