IUIX_Combo::SelItemByParam Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 2: Line 2:
 
{{#customTitle:IUIX_Combo::SelItemByParam Method}}
 
{{#customTitle:IUIX_Combo::SelItemByParam Method}}
 
{{#parentPage:PXV:IUIX_Combo|SelItemByParam Method|method}}
 
{{#parentPage:PXV:IUIX_Combo|SelItemByParam Method|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Selects an item with a required ''parameter'' value.
  
 
== Syntax ==
 
== Syntax ==
Line 13: Line 12:
 
== Parameters ==
 
== Parameters ==
 
;nItemParam
 
;nItemParam
:[in]  Value of PARAM_T.
+
:[in]  parameter of an item that is to be selected.
 
;pIndex
 
;pIndex
:[out, retval, defaultvalue(NULL)]  Pointer to LONG.
+
:[out, retval, defaultvalue(NULL)]  optional value of number of selected item. Returns -1 if there were no items with a given parameter.
  
 
== Return Value ==
 
== Return Value ==

Revision as of 08:33, 8 May 2015


Selects an item with a required parameter value.

Syntax

HRESULT SelItemByParam([in]                               PARAM_T  nItemParam,
                       [out, retval, defaultvalue(NULL)]  LONG*    pIndex);

Parameters

nItemParam
[in] parameter of an item that is to be selected.
pIndex
[out, retval, defaultvalue(NULL)] optional value of number of selected item. Returns -1 if there were no items with a given parameter.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

See also IUIX_Combo.