IUIX_CmdMenu::DeleteItemsByCmdID Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
 
(7 intermediate revisions by one other user not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_CmdMenu::DeleteItemsByCmdID Method}}
 
{{#customTitle:IUIX_CmdMenu::DeleteItemsByCmdID Method}}
 +
{{#parentPage:PXV:IUIX_CmdMenu#Methods|DeleteItemsByCmdID|method}}
 +
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Removes command menu items that correspond to the given command ID.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT DeleteItemsByCmdID([in] LONG nCmdID, [in, optional] VARIANT_BOOL bRecursive, [in, optional] VARIANT_BOOL bFirstOnly);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT DeleteItemsByCmdID([in]                   LONG         nCmdID,
 +
                          [in, defaultvalue(-1)] VARIANT_BOOL bRecursive,
 +
                          [in, defaultvalue(0)]   VARIANT_BOOL bFirstOnly);</pre>
  
 
== 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, optional]  Value of VARIANT_BOOL.
+
:[in, defaultvalue(-1)]  Value of VARIANT_BOOL representing whether the command menu items should be removed recursively.
;''bFirstOnly''
+
;bFirstOnly
:[in, optional]  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 ==
Line 19: Line 24:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IUIX_CmdMenu|IUIX_CmdMenu]].
+
[[PXV:IUIX_CmdMenu|IUIX_CmdMenu]]

Latest revision as of 07: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