IPXC_ActionHandler::CreateEmptyAction Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_ActionHandler::CreateEmptyAction Method}}
 
{{#customTitle:IPXC_ActionHandler::CreateEmptyAction Method}}
{{#parentPage:PXV:IPXC_ActionHandler|method}}
+
{{#parentPage:PXV:IPXC_ActionHandler#Methods|CreateEmptyAction|method}}
{{ToReview}}
+
  
Creates new empty action by type.
+
Creates a new empty action by type.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT CreateEmptyAction([in] ULONG nActionType, [in] IPXC_Document* pDoc, [out, retval] IPXC_Action** ppAction);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT CreateEmptyAction([in]           ULONG           nActionType,
 +
                          [in]           IPXC_Document* pDoc,
 +
                          [out, retval] IPXC_Action**   ppAction);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''nActionType''
+
;nActionType
 
:[in] The type of the action that should be created.
 
:[in] The type of the action that should be created.
;''pDoc''
+
;pDoc
:[in]  Pointer to [[PXV:IPXC_Document|IPXC_Document]] containing the source document of the action.
+
:[in]  Pointer to a [[PXV:IPXC_Document|IPXC_Document]] containing the source document of the action.
;''ppAction''
+
;ppAction
:[out, retval]  Pointer to [[PXV:IPXC_Action|IPXC_Action]] containing the newly created action.
+
:[out, retval]  Pointer to a [[PXV:IPXC_Action|IPXC_Action]] containing the newly created action.
  
 
== Return Value ==
 
== Return Value ==
Returns S_OK if operation was successful or error code in other cases.
+
Returns S_OK if operation was successful or an error code in other cases.
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXC_ActionHandler|IPXC_ActionHandler]].
+
[[PXV:IPXC_ActionHandler|IPXC_ActionHandler]]

Latest revision as of 08:02, 23 May 2015

Creates a new empty action by type.

Syntax

HRESULT CreateEmptyAction([in]           ULONG           nActionType,
                          [in]           IPXC_Document*  pDoc,
                          [out, retval]  IPXC_Action**   ppAction);

Parameters

nActionType
[in] The type of the action that should be created.
pDoc
[in] Pointer to a IPXC_Document containing the source document of the action.
ppAction
[out, retval] Pointer to a IPXC_Action containing the newly created action.

Return Value

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

See Also

IPXC_ActionHandler