IUIX_CmdBar::FlatFindFirstItemByCmdName Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
 
(7 intermediate revisions by one other user not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_CmdBar::FlatFindFirstItemByCmdName Method}}
 
{{#customTitle:IUIX_CmdBar::FlatFindFirstItemByCmdName Method}}
 +
{{#parentPage:PXV:IUIX_CmdBar#Methods|FlatFindFirstItemByCmdName|method}}
 +
{{ToReview}}
 +
 +
Gets [[PXV:IUIX_CmdItem_FlatIndex|FlatIndex]] of the first item in the commands bar that corresponds to the command's name.
  
The method of interface of PDF-XChange Editor SDK.
 
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT FlatFindFirstItemByCmdName([in] BSTR pCmdName, [out, retval] LONG* pFlatIndex);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT FlatFindFirstItemByCmdName([in]           BSTR   sCmdName,
 +
                                  [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 ==
Line 17: Line 22:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IUIX_CmdBar|IUIX_CmdBar]].
+
[[PXV:IUIX_CmdBar|IUIX_CmdBar]]

Latest revision as of 08: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