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)
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IAFS_FileSys::OpenFile Method}}
 
{{#customTitle:IAFS_FileSys::OpenFile Method}}
 +
{{#parentPage:PXV:IAFS_FileSys#Methods|OpenFile|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 OpenFile([in] IAFS_Name* pName, LONG nOpenFlags, [in, defaultvalue(NULL)] IString* pErrDetails, [in, 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** pFile);</pre>
  
 
== Parameters ==
 
== Parameters ==
;''pName''
+
;pName
 
:[in]  Pointer to [[PXV:IAFS_Name|IAFS_Name]].
 
:[in]  Pointer to [[PXV:IAFS_Name|IAFS_Name]].
;''nOpenFlags''
+
;nOpenFlags
 
: Value of LONG.
 
: Value of LONG.
;''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]].
;''ppFile''
+
;pFile
 
:[out, retval]  Pointer to [[PXV:IAFS_File|IAFS_File]].
 
:[out, retval]  Pointer to [[PXV:IAFS_File|IAFS_File]].
  
Line 23: Line 31:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IAFS_FileSys|IAFS_FileSys]].
+
[[PXV:IAFS_FileSys|IAFS_FileSys]]

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