IUIX_CmdItemBox::DeleteItemsByCmd 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_CmdItemBox::DeleteItemsByCmd Method}}
 
{{#customTitle:IUIX_CmdItemBox::DeleteItemsByCmd Method}}
 +
{{#parentPage:PXV:IUIX_CmdItemBox#Methods|DeleteItemsByCmd|method}}
 +
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Removes command items from the command items box by the correspondent [[PXV:IUIX_Cmd|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''
+
;pCmd
:[in]  Pointer to [[PXV:IUIX_Cmd|IUIX_Cmd]].
+
:[in]  Pointer to [[PXV:IUIX_Cmd|IUIX_Cmd]] containing the command that will be used to remove correspondent command items.
;''bRecursive''
+
;bRecursive
:[in, defaultvalue(-1)]  Value of VARIANT_BOOL.
+
:[in, defaultvalue(-1)]  Value of VARIANT_BOOL representing whether the search should be recursive (in command itemss sub-menus).
;''bFirstOnly''
+
;bFirstOnly
:[in, defaultvalue(0)]  Value of VARIANT_BOOL.
+
:[in, defaultvalue(0)]  Value of VARIANT_BOOL representing whether the only first corresponding item should be removed.
  
 
== Return Value ==
 
== Return Value ==
Line 19: Line 24:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IUIX_CmdItemBox|IUIX_CmdItemBox]].
+
[[PXV:IUIX_CmdItemBox|IUIX_CmdItemBox]]

Latest revision as of 07:57, 24 March 2016


Removes command items from the command items box by the correspondent 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 that will be used to remove correspondent command items.
bRecursive
[in, defaultvalue(-1)] Value of VARIANT_BOOL representing whether the search should be recursive (in command itemss sub-menus).
bFirstOnly
[in, defaultvalue(0)] Value of VARIANT_BOOL representing whether the only first corresponding item should be removed.

Return Value

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

See Also

IUIX_CmdItemBox