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

Revision as of 08:43, 10 June 2015


The method of interface of PDF-XChange Editor SDK.

Syntax

HRESULT OpenFile([in]                      IAFS_Name*   Name,
                                           LONG         OpenFlags,
                 [in, defaultvalue(NULL)]  IString*     ErrDetails,
                 [in, defaultvalue(NULL)]  IFlag*       CancelFlag,
                 [out, retval]             IAFS_File**  File);

Parameters

Name
[in] Pointer to IAFS_Name.
OpenFlags
Value of LONG.
ErrDetails
[in, defaultvalue(NULL)] Pointer to IString.
CancelFlag
[in, defaultvalue(NULL)] Pointer to IFlag.
File
[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