IPXC_ActionsList::CopyTo Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
m (Automatic page editing by robot)
 
(11 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_ActionsList::CopyTo Method}}
 
{{#customTitle:IPXC_ActionsList::CopyTo Method}}
 +
{{#parentPage:PXV:IPXC_ActionsList#Methods|CopyTo|method}}
  
The method of interface of PDF-XChange Editor SDK.
+
Copies the actions list data into an existing actions list.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT CopyTo([in] IPXC_Document* pDestDoc, [in, optional] VARIANT_BOOL bIndirect, [in, optional] IPXC_RemapCallback* pRemap, [out, retval] IPXS_PDFVariant** ppCopy);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT CopyTo([in]                     IPXC_Document*       pDestDoc,
 +
              [in, defaultvalue(0)]     VARIANT_BOOL         bIndirect,
 +
              [in, defaultvalue(NULL)] IPXC_RemapCallback* pRemap,
 +
              [out, retval]             IPXS_PDFVariant**   ppCopy);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pDestDoc''
+
;pDestDoc
:[in]  Pointer to [[PXV:IPXC_Document|IPXC_Document]].
+
:[in]  Pointer to [[PXV:IPXC_Document|IPXC_Document]] containing the designated document.
;''bIndirect''
+
;bIndirect
:[in, optionalValue of VARIANT_BOOL.
+
:[in, defaultvalue(0)Choose whether the variant should be indirect.
;''pRemap''
+
;pRemap
:[in, optional]  Pointer to [[PXV:IPXC_RemapCallback|IPXC_RemapCallback]].
+
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IPXC_RemapCallback|IPXC_RemapCallback]] containing callback for page mapping.
;''ppCopy''
+
;ppCopy
:[out, retval]  Pointer to [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]].
+
:[out, retval]  Pointer to [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] containing newly created copy of the actions list structure.
  
 
== Return Value ==
 
== Return Value ==
Returns S_OK if operation was successful or error code in other cases.
+
Returns S_OK if the operation was successful, or will return an error code if it fails.
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXC_ActionsList|IPXC_ActionsList]].
+
[[PXV:IPXC_ActionsList|IPXC_ActionsList]]

Latest revision as of 08:03, 23 May 2015

Copies the actions list data into an existing actions list.

Syntax

HRESULT CopyTo([in]                      IPXC_Document*       pDestDoc,
               [in, defaultvalue(0)]     VARIANT_BOOL         bIndirect,
               [in, defaultvalue(NULL)]  IPXC_RemapCallback*  pRemap,
               [out, retval]             IPXS_PDFVariant**    ppCopy);

Parameters

pDestDoc
[in] Pointer to IPXC_Document containing the designated document.
bIndirect
[in, defaultvalue(0)] Choose whether the variant should be indirect.
pRemap
[in, defaultvalue(NULL)] Pointer to IPXC_RemapCallback containing callback for page mapping.
ppCopy
[out, retval] Pointer to IPXS_PDFVariant containing newly created copy of the actions list structure.

Return Value

Returns S_OK if the operation was successful, or will return an error code if it fails.

See Also

IPXC_ActionsList