IAFS_Inst::CopyStreamToFile Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
Line 9: Line 9:
  
 
== Syntax ==
 
== Syntax ==
−
<pre class="brush:cpp;gutter:false">HRESULT CopyStreamToFile([in]                      IStream*          pSrcStream,
+
<pre class="brush:cpp;gutter:false">HRESULT CopyStreamToFile([in]                      IStream*          SrcStream,
−
                         [in]                      IAFS_File*        pDstFile,
+
                         [in]                      IAFS_File*        DstFile,
−
                         [in, defaultvalue(0)]    VARIANT_BOOL      bKeepPositions,
+
                         [in, defaultvalue(0)]    VARIANT_BOOL      KeepPositions,
−
                         [in, defaultvalue(NULL)]  IAFS_ProgressMon*  pProgMon,
+
                         [in, defaultvalue(NULL)]  IAFS_ProgressMon*  ProgMon,
−
                         [in, defaultvalue(NULL)]  IString*          pErrDetails,
+
                         [in, defaultvalue(NULL)]  IString*          ErrDetails,
−
                         [in, defaultvalue(NULL)]  IFlag*            pCancelFlag);</pre>
+
                         [in, defaultvalue(NULL)]  IFlag*            CancelFlag);</pre>
  
 
== Parameters ==
 
== Parameters ==
−
;pSrcStream
+
;SrcStream
 
:[in]  Pointer to IStream.
 
:[in]  Pointer to IStream.
−
;pDstFile
+
;DstFile
 
:[in]  Pointer to [[PXV:IAFS_File|IAFS_File]].
 
:[in]  Pointer to [[PXV:IAFS_File|IAFS_File]].
−
;bKeepPositions
+
;KeepPositions
 
:[in, defaultvalue(0)]  Value of VARIANT_BOOL.
 
:[in, defaultvalue(0)]  Value of VARIANT_BOOL.
−
;pProgMon
+
;ProgMon
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IAFS_ProgressMon|IAFS_ProgressMon]].
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IAFS_ProgressMon|IAFS_ProgressMon]].
−
;pErrDetails
+
;ErrDetails
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IString|IString]].
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IString|IString]].
−
;pCancelFlag
+
;CancelFlag
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IFlag|IFlag]].
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IFlag|IFlag]].
  

Revision as of 08:43, 10 June 2015

File Systems Layer > Interfaces > IAFS_Inst > IAFS_Inst::CopyStreamToFile Method


The method of interface of PDF-XChange Editor SDK.

Syntax

HRESULT CopyStreamToFile([in]                      IStream*           SrcStream,
                         [in]                      IAFS_File*         DstFile,
                         [in, defaultvalue(0)]     VARIANT_BOOL       KeepPositions,
                         [in, defaultvalue(NULL)]  IAFS_ProgressMon*  ProgMon,
                         [in, defaultvalue(NULL)]  IString*           ErrDetails,
                         [in, defaultvalue(NULL)]  IFlag*             CancelFlag);

Parameters

SrcStream
[in] Pointer to IStream.
DstFile
[in] Pointer to IAFS_File.
KeepPositions
[in, defaultvalue(0)] Value of VARIANT_BOOL.
ProgMon
[in, defaultvalue(NULL)] Pointer to IAFS_ProgressMon.
ErrDetails
[in, defaultvalue(NULL)] Pointer to IString.
CancelFlag
[in, defaultvalue(NULL)] Pointer to IFlag.

Return Value

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

See Also

IAFS_Inst

Retrieved from "https://sdkhelp.pdf-xchange.com/index.php?title=PXV:IAFS_Inst_CopyStreamToFile&oldid=41959"