IAFS_Inst::CopyFileToStream Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
Line 5: Line 5:
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT CopyFileToStream([in] IAFS_File* pSrcFile, [in] IStream* pDstStream, [in, optional, defaultvalue(0)] VARIANT_BOOL bKeepPositions, [in, optional, defaultvalue(NULL)] IAFS_ProgressMon* pProgMon, [in, optional, defaultvalue(NULL)] IString* pErrDetails, [in, optional, defaultvalue(NULL)] IFlag* pCancelFlag);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT CopyFileToStream([in] IAFS_File* pSrcFile, [in] IStream* pDstStream, [in, defaultvalue(0)] VARIANT_BOOL bKeepPositions, [in, defaultvalue(NULL)] IAFS_ProgressMon* pProgMon, [in, defaultvalue(NULL)] IString* pErrDetails, [in, defaultvalue(NULL)] IFlag* pCancelFlag);</pre>
  
 
== Parameters ==
 
== Parameters ==
Line 13: Line 13:
 
:[in]  Pointer to IStream.
 
:[in]  Pointer to IStream.
 
;''bKeepPositions''
 
;''bKeepPositions''
:[in, optional, defaultvalue(0)]  Value of VARIANT_BOOL.
+
:[in, defaultvalue(0)]  Value of VARIANT_BOOL.
 
;''pProgMon''
 
;''pProgMon''
:[in, optional, defaultvalue(NULL)]  Pointer to [[PXV:IAFS_ProgressMon|IAFS_ProgressMon]].
+
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IAFS_ProgressMon|IAFS_ProgressMon]].
 
;''pErrDetails''
 
;''pErrDetails''
:[in, optional, defaultvalue(NULL)]  Pointer to [[PXV:IString|IString]].
+
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IString|IString]].
 
;''pCancelFlag''
 
;''pCancelFlag''
:[in, optional, defaultvalue(NULL)]  Pointer to [[PXV:IFlag|IFlag]].
+
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IFlag|IFlag]].
  
 
== Return Value ==
 
== Return Value ==

Revision as of 13:15, 16 April 2015

The method of interface of PDF-XChange Editor SDK.

Syntax

HRESULT CopyFileToStream([in] IAFS_File* pSrcFile, [in] IStream* pDstStream, [in, defaultvalue(0)] VARIANT_BOOL bKeepPositions, [in, defaultvalue(NULL)] IAFS_ProgressMon* pProgMon, [in, defaultvalue(NULL)] IString* pErrDetails, [in, defaultvalue(NULL)] IFlag* pCancelFlag);

Parameters

pSrcFile
[in] Pointer to IAFS_File.
pDstStream
[in] Pointer to IStream.
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

See also IAFS_Inst.