IUIX_CmdItemBox::FindItemByCtl Method

Latest revision as of 08:04, 24 March 2016

UI Layer > Interfaces > IUIX_CmdItemBox > IUIX_CmdItemBox::FindItemByCtl Method

Searches for the first command item in the command items box by the correspondent command's sub-control.

HRESULT FindItemByCtl([in]           IUIX_Obj*  pCtl,
                      [out, retval]  LONG*      nIndex);

pCtl: [in] Pointer to IUIX_Obj containing the command's sub-control 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.

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

@@ Line 1: / Line 1: @@
+__NOTOC__
 [[Category:Editor]]
 {{#customTitle:IUIX_CmdItemBox::FindItemByCtl Method}}
+{{#parentPage:PXV:IUIX_CmdItemBox#Methods|FindItemByCtl|method}}
+{{ToReview}}
-The method of interface of PDF-XChange Editor SDK.
+Searches for the first command item in the command items box by the correspondent command's sub-control.
 == Syntax ==
-<pre class="brush:cpp;gutter:false">HRESULT FindItemByCtl([in] IUIX_Obj* pCtl, [out, retval] LONG* pIndex);</pre>
+<pre class="brush:cpp;gutter:false">HRESULT FindItemByCtl([in]           IUIX_Obj*  pCtl,
+                      [out, retval]  LONG*      nIndex);</pre>
 == Parameters ==
-;''pCtl''
+;pCtl
-:[in]  Pointer to [[PXV:IUIX_Obj|IUIX_Obj]].
+:[in]  Pointer to [[PXV:IUIX_Obj|IUIX_Obj]] containing the command's sub-control that will be used to find first correspondent command item.
-;''pIndex''
+;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 ==
@@ Line 17: / Line 21: @@
 == See Also ==
-See also [[PXV:IUIX_CmdItemBox|IUIX_CmdItemBox]].
+[[PXV:IUIX_CmdItemBox|IUIX_CmdItemBox]]