IUIX_Combo::SelItemByParam Method
From PDF XChange PDF SDK
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IUIX_Combo::SelItemByParam Method}} | {{#customTitle:IUIX_Combo::SelItemByParam Method}} | ||
| − | {{#parentPage:PXV:IUIX_Combo|SelItemByParam | + | {{#parentPage:PXV:IUIX_Combo#Methods|SelItemByParam|method}} |
| − | + | ||
Selects an item with a required ''parameter'' value. | Selects an item with a required ''parameter'' value. | ||
| Line 8: | Line 9: | ||
== Syntax == | == Syntax == | ||
<pre class="brush:cpp;gutter:false">HRESULT SelItemByParam([in] PARAM_T nItemParam, | <pre class="brush:cpp;gutter:false">HRESULT SelItemByParam([in] PARAM_T nItemParam, | ||
| − | [out, retval, defaultvalue(NULL)] LONG* | + | [out, retval, defaultvalue(NULL)] LONG* nIndex);</pre> |
== Parameters == | == Parameters == | ||
;nItemParam | ;nItemParam | ||
:[in] parameter of an item that is to be selected. | :[in] parameter of an item that is to be selected. | ||
| − | ; | + | ;nIndex |
| − | :[out, retval, defaultvalue(NULL)] optional value | + | :[out, retval, defaultvalue(NULL)] optional value of selected item number. Returns -1 if there were no items with a given parameter. |
== Return Value == | == Return Value == | ||
| − | Returns S_OK if operation was successful or error code | + | Returns S_OK if the operation was successful, or will return an error code if it fails. |
== See Also == | == See Also == | ||
| − | + | [[PXV:IUIX_Combo|IUIX_Combo]] | |
Latest revision as of 13:19, 15 June 2015
Selects an item with a required parameter value.
Syntax
HRESULT SelItemByParam([in] PARAM_T nItemParam,
[out, retval, defaultvalue(NULL)] LONG* nIndex);
Parameters
- nItemParam
- [in] parameter of an item that is to be selected.
- nIndex
- [out, retval, defaultvalue(NULL)] optional value of selected item number. Returns -1 if there were no items with a given parameter.
Return Value
Returns S_OK if the operation was successful, or will return an error code if it fails.
