IPXC_Document::WriteTo Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(6 intermediate revisions by one other user not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_Document::WriteTo Method}}
 
{{#customTitle:IPXC_Document::WriteTo Method}}
{{#parentPage:PXV:IPXC_Document|WriteTo Method|method}}
+
{{#parentPage:PXV:IPXC_Document#Methods|WriteTo|method}}
{{ToWrite}}
+
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Writes the document to the given destination.
  
 
== Syntax ==
 
== Syntax ==
Line 14: Line 14:
 
== Parameters ==
 
== Parameters ==
 
;pDest
 
;pDest
:[in]  Pointer to IUnknown*.
+
:[in]  Pointer to IUnknown* containing the destination. Can be [[PXV:IAFS_File|IAFS_File]], [[PXV:IStream|IStream]] or '''null'''. If '''null''' value is specified the document will be saved to the file that it was opened from.
 
;pProgress
 
;pProgress
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IProgressMon|IProgressMon]].
+
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IProgressMon|IProgressMon]] containing the custom progress if one is needed.
 
;nFlags
 
;nFlags
:[in, defaultvalue(0)]  Value of ULONG.
+
:[in, defaultvalue(0)]  Value of ULONG containing the [[PXV:PXC_DocumentWriteFlags|document write flags]].
  
 
== Return Value ==
 
== Return Value ==
Line 24: Line 24:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IPXC_Document|IPXC_Document]].
+
[[PXV:IPXC_Document|IPXC_Document]]

Latest revision as of 05:40, 2 November 2016


Writes the document to the given destination.

Syntax

HRESULT WriteTo([in]                      IUnknown*      pDest,
                [in, defaultvalue(NULL)]  IProgressMon*  pProgress,
                [in, defaultvalue(0)]     ULONG          nFlags);

Parameters

pDest
[in] Pointer to IUnknown* containing the destination. Can be IAFS_File, IStream or null. If null value is specified the document will be saved to the file that it was opened from.
pProgress
[in, defaultvalue(NULL)] Pointer to IProgressMon containing the custom progress if one is needed.
nFlags
[in, defaultvalue(0)] Value of ULONG containing the document write flags.

Return Value

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

See Also

IPXC_Document