IIXC_Image::Save Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IIXC_Image::Save Method}}
 
{{#customTitle:IIXC_Image::Save Method}}
{{#parentPage:PXV:IIXC_Image|Save Method|method}}
+
{{#parentPage:PXV:IIXC_Image#Methods|Save|method}}
{{ToWrite}}
+
{{ToReview}}
+
  
The method of interface of PDF-XChange Editor SDK.
+
This method saves all pages from the specified image, into a file.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT Save([in]  LPWSTR                  pImagePath,
+
<pre class="brush:cpp;gutter:false">HRESULT Save([in]  LPWSTR                  sImagePath,
 
             [in]  IXC_CreationDisposition  nAction);</pre>
 
             [in]  IXC_CreationDisposition  nAction);</pre>
  
 
== Parameters ==
 
== Parameters ==
;pImagePath
+
;sImagePath
:[in]  Value of LPWSTR.
+
:[in]  Specifies the name of the destination file.
 
;nAction
 
;nAction
:[in]  Value of [[PXV:IXC_CreationDisposition|IXC_CreationDisposition]].
+
:[in]  Value of [[PXV:IXC_CreationDisposition|IXC_CreationDisposition]] specifies how the destination file should be created.
  
 
== 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 error code if not successful.
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IIXC_Image|IIXC_Image]].
+
[[PXV:IIXC_Image|IIXC_Image]]

Latest revision as of 03:15, 15 June 2015

This method saves all pages from the specified image, into a file.

Syntax

HRESULT Save([in]  LPWSTR                   sImagePath,
             [in]  IXC_CreationDisposition  nAction);

Parameters

sImagePath
[in] Specifies the name of the destination file.
nAction
[in] Value of IXC_CreationDisposition specifies how the destination file should be created.

Return Value

Returns S_OK if operation was successful, or error code if not successful.

See Also

IIXC_Image