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*          SrcStream,
+
<pre class="brush:cpp;gutter:false">HRESULT CopyStreamToFile([in]                      IStream*          pSrcStream,
                         [in]                      IAFS_File*        DstFile,
+
                         [in]                      IAFS_File*        pDstFile,
                         [in, defaultvalue(0)]    VARIANT_BOOL      KeepPositions,
+
                         [in, defaultvalue(0)]    VARIANT_BOOL      bKeepPositions,
                         [in, defaultvalue(NULL)]  IAFS_ProgressMon*  ProgMon,
+
                         [in, defaultvalue(NULL)]  IAFS_ProgressMon*  pProgMon,
                         [in, defaultvalue(NULL)]  IString*          ErrDetails,
+
                         [in, defaultvalue(NULL)]  IString*          pErrDetails,
                         [in, defaultvalue(NULL)]  IFlag*            CancelFlag);</pre>
+
                         [in, defaultvalue(NULL)]  IFlag*            pCancelFlag);</pre>
  
 
== Parameters ==
 
== Parameters ==
;SrcStream
+
;pSrcStream
 
:[in]  Pointer to IStream.
 
:[in]  Pointer to IStream.
;DstFile
+
;pDstFile
 
:[in]  Pointer to [[PXV:IAFS_File|IAFS_File]].
 
:[in]  Pointer to [[PXV:IAFS_File|IAFS_File]].
;KeepPositions
+
;bKeepPositions
 
:[in, defaultvalue(0)]  Value of VARIANT_BOOL.
 
:[in, defaultvalue(0)]  Value of VARIANT_BOOL.
;ProgMon
+
;pProgMon
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IAFS_ProgressMon|IAFS_ProgressMon]].
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IAFS_ProgressMon|IAFS_ProgressMon]].
;ErrDetails
+
;pErrDetails
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IString|IString]].
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IString|IString]].
;CancelFlag
+
;pCancelFlag
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IFlag|IFlag]].
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IFlag|IFlag]].
  

Latest revision as of 03:10, 15 June 2015


The method of interface of PDF-XChange Editor SDK.

Syntax

HRESULT CopyStreamToFile([in]                      IStream*           pSrcStream,
                         [in]                      IAFS_File*         pDstFile,
                         [in, defaultvalue(0)]     VARIANT_BOOL       bKeepPositions,
                         [in, defaultvalue(NULL)]  IAFS_ProgressMon*  pProgMon,
                         [in, defaultvalue(NULL)]  IString*           pErrDetails,
                         [in, defaultvalue(NULL)]  IFlag*             pCancelFlag);

Parameters

pSrcStream
[in] Pointer to IStream.
pDstFile
[in] Pointer to IAFS_File.
bKeepPositions
[in, defaultvalue(0)] Value of VARIANT_BOOL.
pProgMon
[in, defaultvalue(NULL)] Pointer to IAFS_ProgressMon.
pErrDetails
[in, defaultvalue(NULL)] Pointer to IString.
pCancelFlag
[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