IUIX_CmdCollection::AddNew2 Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(4 intermediate revisions by one other user not shown)
Line 2: Line 2:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IUIX_CmdCollection::AddNew2 Method}}
 
{{#customTitle:IUIX_CmdCollection::AddNew2 Method}}
{{#parentPage:PXV:IUIX_CmdCollection|AddNew2 Method|method}}
+
{{#parentPage:PXV:IUIX_CmdCollection#Methods|AddNew2|method}}
{{ToWrite}}
+
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Adds new command to the command collection by the given command ID.
  
 
== Syntax ==
 
== Syntax ==
Line 12: Line 11:
 
                 [in]          LONG              nTargetID,
 
                 [in]          LONG              nTargetID,
 
                 [in]          IUIX_CmdHandler*  pHandler,
 
                 [in]          IUIX_CmdHandler*  pHandler,
                 [out, retval]  IUIX_Cmd**        ppNewCmd);</pre>
+
                 [out, retval]  IUIX_Cmd**        pNewCmd);</pre>
  
 
== Parameters ==
 
== Parameters ==
 
;nID
 
;nID
:[in]  Value of LONG.
+
:[in]  Value of LONG containing the command's ID.
 
;nTargetID
 
;nTargetID
:[in]  Value of LONG.
+
:[in]  Value of LONG containing the target's ID.
 
;pHandler
 
;pHandler
:[in]  Pointer to [[PXV:IUIX_CmdHandler|IUIX_CmdHandler]].
+
:[in]  Pointer to [[PXV:IUIX_CmdHandler|IUIX_CmdHandler]] containing the command's handler.
;ppNewCmd
+
;pNewCmd
:[out, retval]  Pointer to [[PXV:IUIX_Cmd|IUIX_Cmd]].
+
:[out, retval]  Pointer to [[PXV:IUIX_Cmd|IUIX_Cmd]] containing the newly added command.
  
 
== Return Value ==
 
== Return Value ==
Line 28: Line 27:
  
 
== See Also ==
 
== See Also ==
[[PXV:IUIX_CmdCollection|IUIX_CmdCollection]].
+
[[PXV:IUIX_CmdCollection|IUIX_CmdCollection]]

Latest revision as of 04:20, 4 April 2016


Adds new command to the command collection by the given command ID.

Syntax

HRESULT AddNew2([in]           LONG              nID,
                [in]           LONG              nTargetID,
                [in]           IUIX_CmdHandler*  pHandler,
                [out, retval]  IUIX_Cmd**        pNewCmd);

Parameters

nID
[in] Value of LONG containing the command's ID.
nTargetID
[in] Value of LONG containing the target's ID.
pHandler
[in] Pointer to IUIX_CmdHandler containing the command's handler.
pNewCmd
[out, retval] Pointer to IUIX_Cmd containing the newly added command.

Return Value

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

See Also

IUIX_CmdCollection