IUIX_CmdBar::FlatFindFirstItemByCmdID Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_CmdBar::FlatFindFirstItemByCmdID Method}}
 
{{#customTitle:IUIX_CmdBar::FlatFindFirstItemByCmdID Method}}
{{#parentPage:PXV:IUIX_CmdBar|FlatFindFirstItemByCmdID Method|method}}
+
{{#parentPage:PXV:IUIX_CmdBar#Methods|FlatFindFirstItemByCmdID|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 ID.
  
 
== Syntax ==
 
== Syntax ==
 
<pre class="brush:cpp;gutter:false">HRESULT FlatFindFirstItemByCmdID([in]          LONG  nCmdID,
 
<pre class="brush:cpp;gutter:false">HRESULT FlatFindFirstItemByCmdID([in]          LONG  nCmdID,
                                 [out, retval]  LONG*  pFlatIndex);</pre>
+
                                 [out, retval]  LONG*  nFlatIndex);</pre>
  
 
== Parameters ==
 
== Parameters ==
 
;nCmdID
 
;nCmdID
:[in]  Value of LONG.
+
:[in]  Value of LONG containing the command's ID.
;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 21: Line 21:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IUIX_CmdBar|IUIX_CmdBar]].
+
[[PXV:IUIX_CmdBar|IUIX_CmdBar]]

Latest revision as of 07:10, 23 March 2016


Gets FlatIndex of the first item in the commands bar that corresponds to the command ID.

Syntax

HRESULT FlatFindFirstItemByCmdID([in]           LONG   nCmdID,
                                 [out, retval]  LONG*  nFlatIndex);

Parameters

nCmdID
[in] Value of LONG containing the command's ID.
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