IUIX_Combo::FindItemByParam 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::FindItemByParam Method}} | {{#customTitle:IUIX_Combo::FindItemByParam Method}} | ||
| − | {{#parentPage:PXV:IUIX_Combo|FindItemByParam | + | {{#parentPage:PXV:IUIX_Combo#Methods|FindItemByParam|method}} |
| − | + | ||
| − | Gets ''index of an item | + | |
| + | Gets ''index'' of an item with a given ''parameter''. | ||
== Syntax == | == Syntax == | ||
<pre class="brush:cpp;gutter:false">HRESULT FindItemByParam([in] PARAM_T nItemParam, | <pre class="brush:cpp;gutter:false">HRESULT FindItemByParam([in] PARAM_T nItemParam, | ||
| − | [out, retval] LONG* | + | [out, retval] LONG* nIndex);</pre> |
== Parameters == | == Parameters == | ||
;nItemParam | ;nItemParam | ||
| − | :[in] | + | :[in] PARAM_T parameter value to search for. |
| − | ; | + | ;nIndex |
:[out, retval] index of found item. Returns -1 if no items with given parameters were found. If there are more than one items with equal parameter values, index of the first of them in combo box list will be returned. | :[out, retval] index of found item. Returns -1 if no items with given parameters were found. If there are more than one items with equal parameter values, index of the first of them in combo box list will be returned. | ||
== 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:04, 15 June 2015
Gets index of an item with a given parameter.
Syntax
HRESULT FindItemByParam([in] PARAM_T nItemParam,
[out, retval] LONG* nIndex);
Parameters
- nItemParam
- [in] PARAM_T parameter value to search for.
- nIndex
- [out, retval] index of found item. Returns -1 if no items with given parameters were found. If there are more than one items with equal parameter values, index of the first of them in combo box list will be returned.
Return Value
Returns S_OK if the operation was successful, or will return an error code if it fails.
