IPXC_ActionHandler::SerializeAction Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_ActionHandler::SerializeAction Method}}
 
{{#customTitle:IPXC_ActionHandler::SerializeAction Method}}
{{#parentPage:PXV:IPXC_ActionHandler|SerializeAction Method|method}}
+
{{#parentPage:PXV:IPXC_ActionHandler#Methods|SerializeAction|method}}
{{ToReview}}
+
  
Generates a storable representation of the action.
+
Generates an action representation that can be stored.
  
 
== Syntax ==
 
== Syntax ==
Line 13: Line 13:
 
== Parameters ==
 
== Parameters ==
 
;pAction
 
;pAction
:[in]  Pointer to [[PXV:IPXC_Action|IPXC_Action]] containing  the source action.
+
:[in]  Pointer to a [[PXV:IPXC_Action|IPXC_Action]] containing  the source action.
 
;pStorage
 
;pStorage
:[in]  Pointer to [[PXV:IPXS_Document|IPXS_Document]] containing the document for action storing.
+
:[in]  Pointer to a [[PXV:IPXS_Document|IPXS_Document]] containing the document for action storing.
 
;ppVar
 
;ppVar
:[out, retval]  Pointer to [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] containing the resulting action structure variant.
+
:[out, retval]  Pointer to a [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] containing the resulting action structure variant.
  
 
== 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

Generates an action representation that can be stored.

Syntax

HRESULT SerializeAction([in]           IPXC_Action*       pAction,
                        [in]           IPXS_Document*     pStorage,
                        [out, retval]  IPXS_PDFVariant**  ppVar);

Parameters

pAction
[in] Pointer to a IPXC_Action containing the source action.
pStorage
[in] Pointer to a IPXS_Document containing the document for action storing.
ppVar
[out, retval] Pointer to a IPXS_PDFVariant containing the resulting action structure variant.

Return Value

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

See Also

IPXC_ActionHandler