IUIX_CmdBar::FlatFindFirstItemByCmdName Method

Latest revision as of 07:12, 23 March 2016

UI Layer > Interfaces > IUIX_CmdBar > IUIX_CmdBar::FlatFindFirstItemByCmdName Method

Gets FlatIndex of the first item in the commands bar that corresponds to the command's name.

HRESULT FlatFindFirstItemByCmdName([in]           BSTR   sCmdName,
                                   [out, retval]  LONG*  nFlatIndex);

sCmdName: [in] Value of BSTR containing the command's name.
nFlatIndex: [out, retval] Pointer to LONG containing the resulting FlatIndex of the command in the command bar.

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

@@ Line 1: / Line 1: @@
+__NOTOC__
 [[Category:Editor]]
 {{#customTitle:IUIX_CmdBar::FlatFindFirstItemByCmdName Method}}
-{{#parentPage:PXV:IUIX_CmdBar|FlatFindFirstItemByCmdName Method|method}}
+{{#parentPage:PXV:IUIX_CmdBar#Methods|FlatFindFirstItemByCmdName|method}}
-{{ToWrite}}
 {{ToReview}}
-The method of interface of PDF-XChange Editor SDK.
+Gets [[PXV:IUIX_CmdItem_FlatIndex|FlatIndex]] of the first item in the commands bar that corresponds to the command's name.
 == Syntax ==
-<pre class="brush:cpp;gutter:false">HRESULT FlatFindFirstItemByCmdName([in]           BSTR   pCmdName,
+<pre class="brush:cpp;gutter:false">HRESULT FlatFindFirstItemByCmdName([in]           BSTR   sCmdName,
-                                    [out, retval]  LONG*  pFlatIndex);</pre>
+                                    [out, retval]  LONG*  nFlatIndex);</pre>
 == Parameters ==
-;pCmdName
+;sCmdName
-:[in]  Value of BSTR.
+:[in]  Value of BSTR containing the command's name.
-;pFlatIndex
+;nFlatIndex
-:[out, retval]  Pointer to LONG.
+:[out, retval]  Pointer to LONG containing the resulting [[PXV:IUIX_CmdItem_FlatIndex|FlatIndex]] of the command in the command bar.
 == Return Value ==
@@ Line 21: / Line 22: @@
 == See Also ==
-See also [[PXV:IUIX_CmdBar|IUIX_CmdBar]].
+[[PXV:IUIX_CmdBar|IUIX_CmdBar]]