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 5: Line 5:
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT OpenFile([in] IAFS_Name* pName, LONG nOpenFlags, [in, optional, defaultvalue(NULL)] IString* pErrDetails, [in, optional, defaultvalue(NULL)] IFlag* pCancelFlag, [out, retval] IAFS_File** ppFile);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT OpenFile([in] IAFS_Name* pName, LONG nOpenFlags, [in, defaultvalue(NULL)] IString* pErrDetails, [in, defaultvalue(NULL)] IFlag* pCancelFlag, [out, retval] IAFS_File** ppFile);</pre>
  
 
== Parameters ==
 
== Parameters ==
Line 13: Line 13:
 
: Value of LONG.
 
: Value of LONG.
 
;''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]].
 
;''ppFile''
 
;''ppFile''
 
:[out, retval]  Pointer to [[PXV:IAFS_File|IAFS_File]].
 
:[out, retval]  Pointer to [[PXV:IAFS_File|IAFS_File]].

Revision as of 13:14, 16 April 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** ppFile);

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.
ppFile
[out, retval] Pointer to IAFS_File.

Return Value

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

See Also

See also IAFS_FileSys.