IUIX_CmdMenu::FindFirstCmd Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
 
(8 intermediate revisions by one other user not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_CmdMenu::FindFirstCmd Method}}
 
{{#customTitle:IUIX_CmdMenu::FindFirstCmd Method}}
 +
{{#parentPage:PXV:IUIX_CmdMenu#Methods|FindFirstCmd|method}}
 +
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Finds command menu item by the given command ID.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT FindFirstCmd([in] LONG nCmdID, [in, optional] VARIANT_BOOL bRecursive, [out, retval] IUIX_Cmd** ppCmd);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT FindFirstCmd([in]                   LONG         nCmdID,
 +
                    [in, defaultvalue(-1)] VARIANT_BOOL bRecursive,
 +
                    [out, retval]           IUIX_Cmd**   pCmd);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''nCmdID''
+
;nCmdID
:[in]  Value of LONG.
+
:[in]  Value of LONG containing the command ID by which the corresponding command menu item should be searched for.
;''bRecursive''
+
;bRecursive
:[in, optional]  Value of VARIANT_BOOL.
+
:[in, defaultvalue(-1)]  Value of VARIANT_BOOL representing whether the search should be done recursively.
;''ppCmd''
+
;pCmd
:[out, retval]  Pointer to [[PXV:IUIX_Cmd|IUIX_Cmd]].
+
:[out, retval]  Pointer to [[PXV:IUIX_Cmd|IUIX_Cmd]] containing the resulting command.
  
 
== 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:40, 31 March 2016


Finds command menu item by the given command ID.

Syntax

HRESULT FindFirstCmd([in]                    LONG          nCmdID,
                     [in, defaultvalue(-1)]  VARIANT_BOOL  bRecursive,
                     [out, retval]           IUIX_Cmd**    pCmd);

Parameters

nCmdID
[in] Value of LONG containing the command ID by which the corresponding command menu item should be searched for.
bRecursive
[in, defaultvalue(-1)] Value of VARIANT_BOOL representing whether the search should be done recursively.
pCmd
[out, retval] Pointer to IUIX_Cmd containing the resulting command.

Return Value

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

See Also

IUIX_CmdMenu