IUIX_CmdBar::DeleteItemsByCmd Method
From PDF XChange PDF SDK
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::DeleteItemsByCmd Method}} | {{#customTitle:IUIX_CmdBar::DeleteItemsByCmd Method}} | ||
| + | {{#parentPage:PXV:IUIX_CmdBar#Methods|DeleteItemsByCmd|method}} | ||
| + | {{ToReview}} | ||
| − | + | Removes [[PXV:IUIX_CmdItem|command items]] from the [[PXV:IUIX_CmdItemBox|command item boxes]] if they contain the given command. | |
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT DeleteItemsByCmd([in] IUIX_Cmd* pCmd, [in, defaultvalue(-1)] VARIANT_BOOL bRecursive, [in, defaultvalue(0)] VARIANT_BOOL bFirstOnly);</pre> | + | <pre class="brush:cpp;gutter:false">HRESULT DeleteItemsByCmd([in] IUIX_Cmd* pCmd, |
| + | [in, defaultvalue(-1)] VARIANT_BOOL bRecursive, | ||
| + | [in, defaultvalue(0)] VARIANT_BOOL bFirstOnly);</pre> | ||
== Parameters == | == Parameters == | ||
| − | ; | + | ;pCmd |
| − | :[in] Pointer to [[PXV:IUIX_Cmd|IUIX_Cmd]]. | + | :[in] Pointer to [[PXV:IUIX_Cmd|IUIX_Cmd]] containing the command by which the command items will be removed. |
| − | ; | + | ;bRecursive |
| − | :[in, defaultvalue(-1)] Value of VARIANT_BOOL. | + | :[in, defaultvalue(-1)] Value of VARIANT_BOOL that indicates whether the search for the command items should be recursive. |
| − | ; | + | ;bFirstOnly |
| − | :[in, defaultvalue(0)] Value of VARIANT_BOOL. | + | :[in, defaultvalue(0)] Value of VARIANT_BOOL that indicates whether only the first command item should be removed. |
== Return Value == | == Return Value == | ||
| Line 19: | Line 24: | ||
== See Also == | == See Also == | ||
| − | + | [[PXV:IUIX_CmdBar|IUIX_CmdBar]] | |
Latest revision as of 03:39, 25 March 2016
Removes command items from the command item boxes if they contain the given command.
Syntax
HRESULT DeleteItemsByCmd([in] IUIX_Cmd* pCmd,
[in, defaultvalue(-1)] VARIANT_BOOL bRecursive,
[in, defaultvalue(0)] VARIANT_BOOL bFirstOnly);
Parameters
- pCmd
- [in] Pointer to IUIX_Cmd containing the command by which the command items will be removed.
- bRecursive
- [in, defaultvalue(-1)] Value of VARIANT_BOOL that indicates whether the search for the command items should be recursive.
- bFirstOnly
- [in, defaultvalue(0)] Value of VARIANT_BOOL that indicates whether only the first command item should be removed.
Return Value
Returns S_OK if operation was successful or error code in other cases.
