IUIX_CmdBar::FlatGetItem 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::FlatGetItem Method}}
 
{{#customTitle:IUIX_CmdBar::FlatGetItem Method}}
 +
{{#parentPage:PXV:IUIX_CmdBar#Methods|FlatGetItem|method}}
 +
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Gets command item from the command bar's command item box by the [[PXV:IUIX_CmdItem_FlatIndex|FlatIndex]].
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT FlatGetItem([in] LONG nFlatIndex, [out, retval] IUIX_CmdItem** ppItem);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT FlatGetItem([in]           LONG           nFlatIndex,
 +
                    [out, retval] IUIX_CmdItem** pItem);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''nFlatIndex''
+
;nFlatIndex
:[in]  Value of LONG.
+
:[in]  Value of LONG containing the [[PXV:IUIX_CmdItem_FlatIndex|FlatIndex]] of the command item.
;''ppItem''
+
;pItem
:[out, retval]  Pointer to [[PXV:IUIX_CmdItem|IUIX_CmdItem]].
+
:[out, retval]  Pointer to [[PXV:IUIX_CmdItem|IUIX_CmdItem]] containing the resulting command item.
  
 
== Return Value ==
 
== Return Value ==
Line 17: Line 21:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IUIX_CmdBar|IUIX_CmdBar]].
+
[[PXV:IUIX_CmdBar|IUIX_CmdBar]]

Latest revision as of 03:45, 25 March 2016


Gets command item from the command bar's command item box by the FlatIndex.

Syntax

HRESULT FlatGetItem([in]           LONG            nFlatIndex,
                    [out, retval]  IUIX_CmdItem**  pItem);

Parameters

nFlatIndex
[in] Value of LONG containing the FlatIndex of the command item.
pItem
[out, retval] Pointer to IUIX_CmdItem containing the resulting command item.

Return Value

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

See Also

IUIX_CmdBar