IPXV_Document::Save Method
From PDF XChange PDF SDK
| Line 3: | Line 3: | ||
{{#customTitle:IPXV_Document::Save Method}} | {{#customTitle:IPXV_Document::Save Method}} | ||
{{#parentPage:PXV:IPXV_Document#Methods|Save|method}} | {{#parentPage:PXV:IPXV_Document#Methods|Save|method}} | ||
| − | |||
{{ToReview}} | {{ToReview}} | ||
| Line 20: | Line 19: | ||
== Parameters == | == Parameters == | ||
;pDest | ;pDest | ||
| − | :[in, defaultvalue(NULL)] Pointer to IUnknown* containing the destination file path. Can be ether [[PXV:IAFS_Name|IAFS_Name]], | + | :[in, defaultvalue(NULL)] Pointer to IUnknown* containing the destination file path. Can be ether [[PXV:IAFS_Name|IAFS_Name]], IStream or NULL. If NULL is specified then the document will be saved to the original file. If the document is newly created, the Save As... dialog will be shown. |
;nFlags | ;nFlags | ||
| − | :[in, defaultvalue(0)] | + | :[in, defaultvalue(0)] Specify the [[PXV:PXV_DocSaveFlags|document save flags]]. |
;pProgress | ;pProgress | ||
| − | :[in, defaultvalue(NULL)] Pointer to [[PXV:IProgressMon|IProgressMon]]. | + | :[in, defaultvalue(NULL)] Pointer to [[PXV:IProgressMon|IProgressMon]] containing the custom initialized progress. |
;pDestConv | ;pDestConv | ||
| − | :[in, defaultvalue(NULL)] Pointer to [[PXV:IPXV_ExportConverter|IPXV_ExportConverter]]. | + | :[in, defaultvalue(NULL)] Pointer to [[PXV:IPXV_ExportConverter|IPXV_ExportConverter]] containing custom export converter. |
;pDestConvParams | ;pDestConvParams | ||
| − | :[in, defaultvalue(NULL)] Pointer to [[PXV:ICab|ICab]]. | + | :[in, defaultvalue(NULL)] Pointer to [[PXV:ICab|ICab]] containing custom export converter cab settings. |
;pDestFS | ;pDestFS | ||
| − | :[in, defaultvalue(NULL)] Pointer to [[PXV:IAFS_FileSys|IAFS_FileSys]]. | + | :[in, defaultvalue(NULL)] Pointer to [[PXV:IAFS_FileSys|IAFS_FileSys]] containing destination file system. |
;pAdvancedParams | ;pAdvancedParams | ||
| − | :[in, defaultvalue(NULL)] Pointer to [[PXV:ICab|ICab]]. | + | :[in, defaultvalue(NULL)] Pointer to [[PXV:ICab|ICab]] containing advanced cab parameters that will be available from the saving document events. |
;hWndParent | ;hWndParent | ||
| − | :[in, defaultvalue(0)] Value of HANDLE_T. | + | :[in, defaultvalue(0)] Value of HANDLE_T containing the parent window handle. |
== Return Value == | == Return Value == | ||
Revision as of 00:52, 16 March 2016
The method of interface of PDF-XChange Editor SDK.
Syntax
HRESULT Save([in, defaultvalue(NULL)] IUnknown* pDest,
[in, defaultvalue(0)] LONG nFlags,
[in, defaultvalue(NULL)] IProgressMon* pProgress,
[in, defaultvalue(NULL)] IPXV_ExportConverter* pDestConv,
[in, defaultvalue(NULL)] ICab* pDestConvParams,
[in, defaultvalue(NULL)] IAFS_FileSys* pDestFS,
[in, defaultvalue(NULL)] ICab* pAdvancedParams,
[in, defaultvalue(0)] HANDLE_T hWndParent);
Parameters
- pDest
- [in, defaultvalue(NULL)] Pointer to IUnknown* containing the destination file path. Can be ether IAFS_Name, IStream or NULL. If NULL is specified then the document will be saved to the original file. If the document is newly created, the Save As... dialog will be shown.
- nFlags
- [in, defaultvalue(0)] Specify the document save flags.
- pProgress
- [in, defaultvalue(NULL)] Pointer to IProgressMon containing the custom initialized progress.
- pDestConv
- [in, defaultvalue(NULL)] Pointer to IPXV_ExportConverter containing custom export converter.
- pDestConvParams
- [in, defaultvalue(NULL)] Pointer to ICab containing custom export converter cab settings.
- pDestFS
- [in, defaultvalue(NULL)] Pointer to IAFS_FileSys containing destination file system.
- pAdvancedParams
- [in, defaultvalue(NULL)] Pointer to ICab containing advanced cab parameters that will be available from the saving document events.
- hWndParent
- [in, defaultvalue(0)] Value of HANDLE_T containing the parent window handle.
Return Value
Returns S_OK if operation was successful or error code in other cases.
