IUIX_CmdCollection::AddNew 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_CmdCollection::AddNew Method}}
 
{{#customTitle:IUIX_CmdCollection::AddNew Method}}
 +
{{#parentPage:PXV:IUIX_CmdCollection#Methods|AddNew|method}}
 +
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Adds new command to the command collection by the given command ID.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT AddNew([in] BSTR pID, [in] BSTR pTargetID, [in] IUIX_CmdHandler* pHandler, [out, retval] IUIX_Cmd** ppNewCmd);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT AddNew([in]           BSTR             sID,
 +
              [in]           BSTR             sTargetID,
 +
              [in]           IUIX_CmdHandler* pHandler,
 +
              [out, retval] IUIX_Cmd**       pNewCmd);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pID''
+
;sID
:[in]  Value of BSTR.
+
:[in]  Value of BSTR containing the command's ID.
;''pTargetID''
+
;sTargetID
:[in]  Value of BSTR.
+
:[in]  Value of BSTR 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 21: Line 27:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IUIX_CmdCollection|IUIX_CmdCollection]].
+
[[PXV:IUIX_CmdCollection|IUIX_CmdCollection]]

Latest revision as of 05:19, 4 April 2016


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

Syntax

HRESULT AddNew([in]           BSTR              sID,
               [in]           BSTR              sTargetID,
               [in]           IUIX_CmdHandler*  pHandler,
               [out, retval]  IUIX_Cmd**        pNewCmd);

Parameters

sID
[in] Value of BSTR containing the command's ID.
sTargetID
[in] Value of BSTR 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