IUIX_CmdBar::FlatInsertSeparator Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| (3 intermediate revisions by one other user not shown) | |||
| Line 2: | Line 2: | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IUIX_CmdBar::FlatInsertSeparator Method}} | {{#customTitle:IUIX_CmdBar::FlatInsertSeparator Method}} | ||
| − | {{#parentPage:PXV:IUIX_CmdBar#Methods|FlatInsertSeparator | + | {{#parentPage:PXV:IUIX_CmdBar#Methods|FlatInsertSeparator|method}} |
| − | + | ||
{{ToReview}} | {{ToReview}} | ||
| − | + | 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, | <pre class="brush:cpp;gutter:false">HRESULT FlatInsertSeparator([in, defaultvalue(-1)] LONG nFlatIndexBefore, | ||
[in, defaultvalue(0)] LONG nStyle, | [in, defaultvalue(0)] LONG nStyle, | ||
| − | [out, retval, defaultvalue(NULL)] IUIX_CmdItem** | + | [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]]. |
| − | ; | + | ;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 25: | Line 24: | ||
== 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.
