IUIX_CmdBar::FlatInsertSeparator Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (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::FlatInsertSeparator Method}}
 
{{#customTitle:IUIX_CmdBar::FlatInsertSeparator Method}}
 +
{{#parentPage:PXV:IUIX_CmdBar#Methods|FlatInsertSeparator|method}}
 +
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Inserts separator by the given [[PXV:IUIX_CmdItem_FlatIndex|FlatIndex]].
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT FlatInsertSeparator([in, defaultvalue(-1)] LONG nFlatIndexBefore, [in, defaultvalue(0)] LONG nStyle, [out, retval, defaultvalue(NULL)] IUIX_CmdItem** ppItem);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT FlatInsertSeparator([in, defaultvalue(-1)]             LONG           nFlatIndexBefore,
 +
                            [in, defaultvalue(0)]             LONG           nStyle,
 +
                            [out, retval, defaultvalue(NULL)] IUIX_CmdItem** pItem);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''nFlatIndexBefore''
+
;nFlatIndexBefore
:[in, defaultvalue(-1)]  Value of LONG.
+
:[in, defaultvalue(-1)]  Value of LONG containing the [[PXV:IUIX_CmdItem_FlatIndex|FlatIndex]] of the command item before which the separator would be inserted.
;''nStyle''
+
;nStyle
:[in, defaultvalue(0)]  Value of LONG.
+
:[in, defaultvalue(0)]  Value of LONG containing the [[PXV:UIX_CmdItemStyleFlags|separator's style]].
;''ppItem''
+
;pItem
:[out, retval, defaultvalue(NULL)]  Pointer to [[PXV:IUIX_CmdItem|IUIX_CmdItem]].
+
:[out, retval, defaultvalue(NULL)]  Pointer to [[PXV:IUIX_CmdItem|IUIX_CmdItem]] containing the newly inserted separator.
  
 
== Return Value ==
 
== Return Value ==
Line 19: Line 24:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IUIX_CmdBar|IUIX_CmdBar]].
+
[[PXV:IUIX_CmdBar|IUIX_CmdBar]]

Latest revision as of 03:55, 25 March 2016


Inserts separator by the given FlatIndex.

Syntax

HRESULT FlatInsertSeparator([in, defaultvalue(-1)]             LONG            nFlatIndexBefore,
                            [in, defaultvalue(0)]              LONG            nStyle,
                            [out, retval, defaultvalue(NULL)]  IUIX_CmdItem**  pItem);

Parameters

nFlatIndexBefore
[in, defaultvalue(-1)] Value of LONG containing the FlatIndex of the command item before which the separator would be inserted.
nStyle
[in, defaultvalue(0)] Value of LONG containing the separator's style.
pItem
[out, retval, defaultvalue(NULL)] Pointer to IUIX_CmdItem containing the newly inserted separator.

Return Value

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

See Also

IUIX_CmdBar