IUIX_CmdBar::FlatItemIsSeparator Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(6 intermediate revisions by one other user not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_CmdBar::FlatItemIsSeparator Method}}
 
{{#customTitle:IUIX_CmdBar::FlatItemIsSeparator Method}}
{{#parentPage:PXV:IUIX_CmdBar|method}}
+
{{#parentPage:PXV:IUIX_CmdBar#Methods|FlatItemIsSeparator|method}}
{{ToWrite}}
+
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Checks whether the given command item is separator by the [[PXV:IUIX_CmdItem_FlatIndex|FlatIndex]].
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT FlatItemIsSeparator([in] LONG nFlatIndex, [out, retval] VARIANT_BOOL* pIsSeparator);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT FlatItemIsSeparator([in]           LONG           nFlatIndex,
 +
                            [out, retval] VARIANT_BOOL* bIsSeparator);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''nFlatIndex''
+
;nFlatIndex
:[in]  Value of LONG.
+
:[in]  Value of LONG containing the [[PXV:IUIX_CmdItem_FlatIndex|FlatIndex]] of the command bar's command item.
;''pIsSeparator''
+
;bIsSeparator
:[out, retval]  Pointer to VARIANT_BOOL.
+
:[out, retval]  Pointer to VARIANT_BOOL that indicates whether the needed command item is separator.
  
 
== Return Value ==
 
== Return Value ==
Line 20: Line 21:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IUIX_CmdBar|IUIX_CmdBar]].
+
[[PXV:IUIX_CmdBar|IUIX_CmdBar]]

Latest revision as of 02:57, 25 March 2016


Checks whether the given command item is separator by the FlatIndex.

Syntax

HRESULT FlatItemIsSeparator([in]           LONG           nFlatIndex,
                            [out, retval]  VARIANT_BOOL*  bIsSeparator);

Parameters

nFlatIndex
[in] Value of LONG containing the FlatIndex of the command bar's command item.
bIsSeparator
[out, retval] Pointer to VARIANT_BOOL that indicates whether the needed command item is separator.

Return Value

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

See Also

IUIX_CmdBar