This is experimental documentation.
Opens the specified file contained within the MPQ.
Declaration Syntax
C# | Visual Basic | Visual C++ |
public MpqFileStream OpenFile( string mpqFilePath )
Public Function OpenFile ( _ mpqFilePath As String _ ) As MpqFileStream
public: MpqFileStream^ OpenFile( String^ mpqFilePath )
Parameters
- mpqFilePath (String)
- The path to the file relative to the MPQ root.
Return Value
An MpqFileStream to the file within the MPQ.
Exceptions
Exception | Condition |
---|---|
MpqException | Thrown if the file is not found or there is a problem reading from the MPQ. |
ArgumentNullException | Thrown if mpqFilePath is null (Nothing in Visual Basic). |
Assembly: Asgard5Library (Module: Asgard5Library)