IUIX_CmdItemBox::InsertItem2 Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| (11 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IUIX_CmdItemBox::InsertItem2 Method}} | {{#customTitle:IUIX_CmdItemBox::InsertItem2 Method}} | ||
| + | {{#parentPage:PXV:IUIX_CmdItemBox#Methods|InsertItem2|method}} | ||
| + | {{ToReview}} | ||
| − | + | Inserts new [[PXV:IUIX_CmdItem|command item]] in the command items box that is related to the given command. | |
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT InsertItem2([in] LONG nCmdID, [in, defaultvalue(-1)] LONG nIndexBefore, [in, defaultvalue(0)] LONG nNewStyle, [in, defaultvalue(0)] LONG nNewStyleMask, [out, retval, defaultvalue(NULL)] IUIX_CmdItem** | + | <pre class="brush:cpp;gutter:false">HRESULT InsertItem2([in] LONG nCmdID, |
| + | [in, defaultvalue(-1)] LONG nIndexBefore, | ||
| + | [in, defaultvalue(0)] LONG nNewStyle, | ||
| + | [in, defaultvalue(0)] LONG nNewStyleMask, | ||
| + | [out, retval, defaultvalue(NULL)] IUIX_CmdItem** pItem);</pre> | ||
== Parameters == | == Parameters == | ||
| − | ; | + | ;nCmdID |
| − | :[in] Value of LONG. | + | :[in] Value of LONG containing the command ID that will be inserted. |
| − | ; | + | ;nIndexBefore |
| − | :[in, defaultvalue(-1)] Value of LONG. | + | :[in, defaultvalue(-1)] Value of LONG containing the command item's insert index. |
| − | ; | + | ;nNewStyle |
| − | :[in, defaultvalue(0)] Value of LONG. | + | :[in, defaultvalue(0)] Value of LONG containing the [[PXV:UIX_CmdItemStyleFlags|new command item's style]]. |
| − | ; | + | ;nNewStyleMask |
| − | :[in, defaultvalue(0)] Value of LONG. | + | :[in, defaultvalue(0)] Value of LONG containing the style mask. |
| − | ; | + | ;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 command item. |
== Return Value == | == Return Value == | ||
| Line 23: | Line 30: | ||
== See Also == | == See Also == | ||
| − | + | [[PXV:IUIX_CmdItemBox|IUIX_CmdItemBox]] | |
Latest revision as of 12:47, 9 June 2016
Inserts new command item in the command items box that is related to the given command.
Syntax
HRESULT InsertItem2([in] LONG nCmdID,
[in, defaultvalue(-1)] LONG nIndexBefore,
[in, defaultvalue(0)] LONG nNewStyle,
[in, defaultvalue(0)] LONG nNewStyleMask,
[out, retval, defaultvalue(NULL)] IUIX_CmdItem** pItem);
Parameters
- nCmdID
- [in] Value of LONG containing the command ID that will be inserted.
- nIndexBefore
- [in, defaultvalue(-1)] Value of LONG containing the command item's insert index.
- nNewStyle
- [in, defaultvalue(0)] Value of LONG containing the new command item's style.
- nNewStyleMask
- [in, defaultvalue(0)] Value of LONG containing the style mask.
- pItem
- [out, retval, defaultvalue(NULL)] Pointer to IUIX_CmdItem containing the newly inserted command item.
Return Value
Returns S_OK if operation was successful or error code in other cases.
