IUIX_CmdMenu::DeleteItemsByCmdID Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
Line 3: Line 3:
 
{{#customTitle:IUIX_CmdMenu::DeleteItemsByCmdID Method}}
 
{{#customTitle:IUIX_CmdMenu::DeleteItemsByCmdID Method}}
 
{{#parentPage:PXV:IUIX_CmdMenu#Methods|DeleteItemsByCmdID|method}}
 
{{#parentPage:PXV:IUIX_CmdMenu#Methods|DeleteItemsByCmdID|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Removes command menu items that correspond to the given command ID.
  
 
== Syntax ==
 
== Syntax ==
Line 15: Line 14:
 
== Parameters ==
 
== Parameters ==
 
;nCmdID
 
;nCmdID
:[in]  Value of LONG.
+
:[in]  Value of LONG containing the command ID by which the corresponding command menu items should be removed.
 
;bRecursive
 
;bRecursive
:[in, defaultvalue(-1)]  Value of VARIANT_BOOL.
+
:[in, defaultvalue(-1)]  Value of VARIANT_BOOL representing whether the command menu items should be removed recursively.
 
;bFirstOnly
 
;bFirstOnly
:[in, defaultvalue(0)]  Value of VARIANT_BOOL.
+
:[in, defaultvalue(0)]  Value of VARIANT_BOOL representing whether only the first item that matches the given criteria should be removed.
  
 
== Return Value ==
 
== Return Value ==

Latest revision as of 06:37, 31 March 2016


Removes command menu items that correspond to the given command ID.

Syntax

HRESULT DeleteItemsByCmdID([in]                    LONG          nCmdID,
                           [in, defaultvalue(-1)]  VARIANT_BOOL  bRecursive,
                           [in, defaultvalue(0)]   VARIANT_BOOL  bFirstOnly);

Parameters

nCmdID
[in] Value of LONG containing the command ID by which the corresponding command menu items should be removed.
bRecursive
[in, defaultvalue(-1)] Value of VARIANT_BOOL representing whether the command menu items should be removed recursively.
bFirstOnly
[in, defaultvalue(0)] Value of VARIANT_BOOL representing whether only the first item that matches the given criteria should be removed.

Return Value

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

See Also

IUIX_CmdMenu