IUIX_CmdItemBox::FindFirstItemByCmdName Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 3: | Line 3: | ||
{{#customTitle:IUIX_CmdItemBox::FindFirstItemByCmdName Method}} | {{#customTitle:IUIX_CmdItemBox::FindFirstItemByCmdName Method}} | ||
{{#parentPage:PXV:IUIX_CmdItemBox#Methods|FindFirstItemByCmdName|method}} | {{#parentPage:PXV:IUIX_CmdItemBox#Methods|FindFirstItemByCmdName|method}} | ||
| − | |||
{{ToReview}} | {{ToReview}} | ||
| − | + | Searches for the first command item in the command items box by the correspondent command's name. | |
== Syntax == | == Syntax == | ||
| Line 14: | Line 13: | ||
== Parameters == | == Parameters == | ||
;sCmdName | ;sCmdName | ||
| − | :[in] Value of BSTR. | + | :[in] Value of BSTR containing the command's name that will be used to find first correspondent command item. |
;nIndex | ;nIndex | ||
| − | :[out, retval] Pointer to LONG. | + | :[out, retval] Pointer to LONG containing the index of the correspondent item. If no command was found then '''-1''' will be returned. |
== Return Value == | == Return Value == | ||
Latest revision as of 08:02, 24 March 2016
Searches for the first command item in the command items box by the correspondent command's name.
Syntax
HRESULT FindFirstItemByCmdName([in] BSTR sCmdName,
[out, retval] LONG* nIndex);
Parameters
- sCmdName
- [in] Value of BSTR containing the command's name that will be used to find first 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.
