IUIX_CmdItemBox::DeleteItemsByCmd Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
Line 3: Line 3:
 
{{#customTitle:IUIX_CmdItemBox::DeleteItemsByCmd Method}}
 
{{#customTitle:IUIX_CmdItemBox::DeleteItemsByCmd Method}}
 
{{#parentPage:PXV:IUIX_CmdItemBox#Methods|DeleteItemsByCmd|method}}
 
{{#parentPage:PXV:IUIX_CmdItemBox#Methods|DeleteItemsByCmd|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{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 ==
Line 15: Line 14:
 
== 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 ==

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