IUIX_CmdItemBox::FindFirstItemByCmdID Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IUIX_CmdItemBox::FindFirstItemByCmdID Method}} | {{#customTitle:IUIX_CmdItemBox::FindFirstItemByCmdID Method}} | ||
| − | {{#parentPage:PXV:IUIX_CmdItemBox#Methods|FindFirstItemByCmdID | + | {{#parentPage:PXV:IUIX_CmdItemBox#Methods|FindFirstItemByCmdID|method}} |
| − | + | ||
{{ToReview}} | {{ToReview}} | ||
| − | + | Searches for the first command item in the command items box by the correspondent command's ID. | |
== Syntax == | == Syntax == | ||
<pre class="brush:cpp;gutter:false">HRESULT FindFirstItemByCmdID([in] LONG nCmdID, | <pre class="brush:cpp;gutter:false">HRESULT FindFirstItemByCmdID([in] LONG nCmdID, | ||
| − | [out, retval] LONG* | + | [out, retval] LONG* nIndex);</pre> |
== Parameters == | == Parameters == | ||
;nCmdID | ;nCmdID | ||
| − | :[in] Value of LONG. | + | :[in] Value of LONG containing the command's ID that will be used to find first correspondent command item. |
| − | ; | + | ;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 == | ||
| Line 22: | Line 21: | ||
== See Also == | == See Also == | ||
| − | [[PXV:IUIX_CmdItemBox|IUIX_CmdItemBox]] | + | [[PXV:IUIX_CmdItemBox|IUIX_CmdItemBox]] |
Latest revision as of 07:02, 24 March 2016
Searches for the first 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's ID 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.
