IUIX_CmdItemBox::FindFirstItemByCmdID Method

From PDF XChange PDF SDK
Jump to: navigation, search
Line 5: Line 5:
 
{{ToReview}}
 
{{ToReview}}
  
Finds command items in the command items box by the correspondent command's ID.
+
Searches for the command item in the command items box by the correspondent command's ID.
  
 
== Syntax ==
 
== Syntax ==
Line 13: Line 13:
 
== Parameters ==
 
== Parameters ==
 
;nCmdID
 
;nCmdID
:[in]  Value of LONG containing the command ID that will be used to find correspondent command items.
+
:[in]  Value of LONG containing the command ID that will be used to find correspondent command item.
 
;nIndex
 
;nIndex
 
:[out, retval]  Pointer to LONG containing the index of the correspondent item. If no command was found then '''-1''' will be returned.
 
:[out, retval]  Pointer to LONG containing the index of the correspondent item. If no command was found then '''-1''' will be returned.

Revision as of 08:01, 24 March 2016


Searches for the command item in the command items box by the correspondent command's ID.

Syntax

HRESULT FindFirstItemByCmdID([in]           LONG   nCmdID,
                             [out, retval]  LONG*  nIndex);

Parameters

nCmdID
[in] Value of LONG containing the command ID that will be used to find correspondent command item.
nIndex
[out, retval] Pointer to LONG containing the index of the correspondent item. If no command was found then -1 will be returned.

Return Value

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

See Also

IUIX_CmdItemBox