IAFS_FileCache::Read Method

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
m (Automatic page editing by robot)
 
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IAFS_FileCache::Read Method}}
 
{{#customTitle:IAFS_FileCache::Read Method}}
 +
{{#parentPage:PXV:IAFS_FileCache#Methods|Read|method}}
 +
{{ToWrite}}
 +
{{ToReview}}
  
 
The method of interface of PDF-XChange Editor SDK.
 
The method of interface of PDF-XChange Editor SDK.
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT Read([in] LONGLONG Pos, [in] void* pv, LONGLONG cbRead, [out] LONGLONG* pcbRead, [in, optional] IString* pErrDetails, [in, optional] IFlag* pCancelFlag);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT Read([in]                     LONGLONG   nPos,
 +
            [in]                     void*     pPv,
 +
                                      LONGLONG   cbRead,
 +
            [out]                     LONGLONG* nRead,
 +
            [in, defaultvalue(NULL)] IString*   pErrDetails,
 +
            [in, defaultvalue(NULL)] IFlag*     pCancelFlag);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''Pos''
+
;nPos
 
:[in]  Value of LONGLONG.
 
:[in]  Value of LONGLONG.
;''pv''
+
;pPv
 
:[in]  Pointer to void.
 
:[in]  Pointer to void.
;''cbRead''
+
;cbRead
 
: Value of LONGLONG.
 
: Value of LONGLONG.
;''pcbRead''
+
;nRead
 
:[out]  Pointer to LONGLONG.
 
:[out]  Pointer to LONGLONG.
;''pErrDetails''
+
;pErrDetails
:[in, optional]  Pointer to [[PXV:IString|IString]].
+
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IString|IString]].
;''pCancelFlag''
+
;pCancelFlag
:[in, optional]  Pointer to [[PXV:IFlag|IFlag]].
+
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IFlag|IFlag]].
  
 
== Return Value ==
 
== Return Value ==
Line 25: Line 34:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IAFS_FileCache|IAFS_FileCache]].
+
[[PXV:IAFS_FileCache|IAFS_FileCache]]

Latest revision as of 04:04, 15 June 2015


The method of interface of PDF-XChange Editor SDK.

Syntax

HRESULT Read([in]                      LONGLONG   nPos,
             [in]                      void*      pPv,
                                       LONGLONG   cbRead,
             [out]                     LONGLONG*  nRead,
             [in, defaultvalue(NULL)]  IString*   pErrDetails,
             [in, defaultvalue(NULL)]  IFlag*     pCancelFlag);

Parameters

nPos
[in] Value of LONGLONG.
pPv
[in] Pointer to void.
cbRead
Value of LONGLONG.
nRead
[out] Pointer to LONGLONG.
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_FileCache