IUIX_Combo::FindItemByParam Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 2: Line 2:
 
{{#customTitle:IUIX_Combo::FindItemByParam Method}}
 
{{#customTitle:IUIX_Combo::FindItemByParam Method}}
 
{{#parentPage:PXV:IUIX_Combo|FindItemByParam Method|method}}
 
{{#parentPage:PXV:IUIX_Combo|FindItemByParam Method|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Gets ''index of an item'' with a given ''parameter''.
  
 
== Syntax ==
 
== Syntax ==
Line 13: Line 12:
 
== Parameters ==
 
== Parameters ==
 
;nItemParam
 
;nItemParam
:[in]  Value of PARAM_T.
+
:[in]  parameter value to search for.
 
;pIndex
 
;pIndex
:[out, retval] Pointer to LONG.
+
:[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 ==

Revision as of 07:57, 7 May 2015


Gets index of an item with a given parameter.

Syntax

HRESULT FindItemByParam([in]           PARAM_T  nItemParam,
                        [out, retval]  LONG*    pIndex);

Parameters

nItemParam
[in] parameter value to search for.
pIndex
[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 operation was successful or error code in other cases.

See Also

See also IUIX_Combo.