IUIX_CmdBar::FlatFindFirstItemByCmdName Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(2 intermediate revisions by one other user not shown)
Line 2: Line 2:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_CmdBar::FlatFindFirstItemByCmdName Method}}
 
{{#customTitle:IUIX_CmdBar::FlatFindFirstItemByCmdName Method}}
{{#parentPage:PXV:IUIX_CmdBar#Methods|FlatFindFirstItemByCmdName Method|method}}
+
{{#parentPage:PXV:IUIX_CmdBar#Methods|FlatFindFirstItemByCmdName|method}}
{{ToWrite}}
+
 
{{ToReview}}
 
{{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 ==
 
== 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 ==
 
== 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 ==
 
== Return Value ==

Latest revision as of 07:12, 23 March 2016


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


Syntax

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

Parameters

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.

Return Value

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

See Also

IUIX_CmdBar