IAFS_File::Read 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 the same user not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IAFS_File::Read Method}}
 
{{#customTitle:IAFS_File::Read Method}}
 +
{{#parentPage:PXV:IAFS_File#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(void* pv, LONGLONG cb, [out] LONGLONG* pcbRead, [in, defaultvalue(NULL)] IString* pErrDetails, [in, defaultvalue(NULL)] IFlag* pCancelFlag);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT Read(                         void*     pPv,
 +
                                      LONGLONG   cb,
 +
            [out]                     LONGLONG* nRead,
 +
            [in, defaultvalue(NULL)] IString*   pErrDetails,
 +
            [in, defaultvalue(NULL)] IFlag*     pCancelFlag);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pv''
+
;pPv
 
: Pointer to void.
 
: Pointer to void.
;''cb''
+
;cb
 
: Value of LONGLONG.
 
: Value of LONGLONG.
;''pcbRead''
+
;nRead
 
:[out]  Pointer to LONGLONG.
 
:[out]  Pointer to LONGLONG.
;''pErrDetails''
+
;pErrDetails
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IString|IString]].
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IString|IString]].
;''pCancelFlag''
+
;pCancelFlag
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IFlag|IFlag]].
 
:[in, defaultvalue(NULL)]  Pointer to [[PXV:IFlag|IFlag]].
  
Line 23: Line 31:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IAFS_File|IAFS_File]].
+
[[PXV:IAFS_File|IAFS_File]]

Latest revision as of 05:04, 15 June 2015


The method of interface of PDF-XChange Editor SDK.

Syntax

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

Parameters

pPv
Pointer to void.
cb
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_File