IAFS_FileSys::OpenFile 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 OpenFile([in]                      IAFS_Name*  Name,
+
<pre class="brush:cpp;gutter:false">HRESULT OpenFile([in]                      IAFS_Name*  pName,
                                           LONG        OpenFlags,
+
                                           LONG        nOpenFlags,
                 [in, defaultvalue(NULL)]  IString*    ErrDetails,
+
                 [in, defaultvalue(NULL)]  IString*    pErrDetails,
                 [in, defaultvalue(NULL)]  IFlag*      CancelFlag,
+
                 [in, defaultvalue(NULL)]  IFlag*      pCancelFlag,
                 [out, retval]            IAFS_File**  File);</pre>
+
                 [out, retval]            IAFS_File**  pFile);</pre>
  
 
== Parameters ==
 
== Parameters ==
;Name
+
;pName
 
:[in]  Pointer to [[PXV:IAFS_Name|IAFS_Name]].
 
:[in]  Pointer to [[PXV:IAFS_Name|IAFS_Name]].
;OpenFlags
+
;nOpenFlags
 
: Value of LONG.
 
: Value of LONG.
;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]].
;File
+
;pFile
 
:[out, retval]  Pointer to [[PXV:IAFS_File|IAFS_File]].
 
:[out, retval]  Pointer to [[PXV:IAFS_File|IAFS_File]].
  

Latest revision as of 02:10, 15 June 2015


The method of interface of PDF-XChange Editor SDK.

Syntax

HRESULT OpenFile([in]                      IAFS_Name*   pName,
                                           LONG         nOpenFlags,
                 [in, defaultvalue(NULL)]  IString*     pErrDetails,
                 [in, defaultvalue(NULL)]  IFlag*       pCancelFlag,
                 [out, retval]             IAFS_File**  pFile);

Parameters

pName
[in] Pointer to IAFS_Name.
nOpenFlags
Value of LONG.
pErrDetails
[in, defaultvalue(NULL)] Pointer to IString.
pCancelFlag
[in, defaultvalue(NULL)] Pointer to IFlag.
pFile
[out, retval] Pointer to IAFS_File.

Return Value

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

See Also

IAFS_FileSys