File::Open Method (String^, FileMode, FileAccess, FileShare)
Opens a FileStream on the specified path, having the specified mode with read, write, or read/write access and the specified sharing option.
Assembly: mscorlib (in mscorlib.dll)
public: static FileStream^ Open( String^ path, FileMode mode, FileAccess access, FileShare share )
Parameters
- path
-
Type:
System::String^
The file to open.
- mode
-
Type:
System.IO::FileMode
A FileMode value that specifies whether a file is created if one does not exist, and determines whether the contents of existing files are retained or overwritten.
- access
-
Type:
System.IO::FileAccess
A FileAccess value that specifies the operations that can be performed on the file.
- share
-
Type:
System.IO::FileShare
A FileShare value specifying the type of access other threads have to the file.
Return Value
Type: System.IO::FileStream^A FileStream on the specified path, having the specified mode with read, write, or read/write access and the specified sharing option.
| Exception | Condition |
|---|---|
| ArgumentException | path is a zero-length string, contains only white space, or contains one or more invalid characters as defined by InvalidPathChars. -or- access specified Read and mode specified Create, CreateNew, Truncate, or Append. |
| ArgumentNullException | path is null. |
| PathTooLongException | The specified path, file name, or both exceed the system-defined maximum length. For example, on Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260 characters. |
| DirectoryNotFoundException | The specified path is invalid, (for example, it is on an unmapped drive). |
| IOException | An I/O error occurred while opening the file. |
| UnauthorizedAccessException | path specified a file that is read-only and access is not Read. -or- path specified a directory. -or- The caller does not have the required permission. -or- mode is Create and the specified file is a hidden file. |
| ArgumentOutOfRangeException | mode, access, or share specified an invalid value. |
| FileNotFoundException | The file specified in path was not found. |
| NotSupportedException | path is in an invalid format. |
The path parameter is permitted to specify relative or absolute path information. Relative path information is interpreted as relative to the current working directory. To obtain the current working directory, see GetCurrentDirectory.
For a list of common I/O tasks, see Common I-O Tasks.
The following example opens a file with read-only access and with file sharing disallowed.
using namespace System; using namespace System::IO; using namespace System::Text; int main() { String^ path = "c:\\temp\\MyTest.txt"; // Create the file if it does not exist. if ( !File::Exists( path ) ) { // Create the file. FileStream^ fs = File::Create( path ); try { array<Byte>^info = (gcnew UTF8Encoding( true ))->GetBytes( "This is some text in the file." ); // Add some information to the file. fs->Write( info, 0, info->Length ); } finally { if ( fs ) delete (IDisposable^)fs; } } // Open the stream and read it back. FileStream^ fs = File::Open( path, FileMode::Open, FileAccess::Read, FileShare::None ); try { array<Byte>^b = gcnew array<Byte>(1024); UTF8Encoding^ temp = gcnew UTF8Encoding( true ); while ( fs->Read( b, 0, b->Length ) > 0 ) { Console::WriteLine( temp->GetString( b ) ); } try { // Try to get another handle to the same file. FileStream^ fs2 = File::Open( path, FileMode::Open ); try { // Do some task here. } finally { if ( fs2 ) delete (IDisposable^)fs2; } } catch ( Exception^ e ) { Console::Write( "Opening the file twice is disallowed." ); Console::WriteLine( ", as expected: {0}", e ); } } finally { if ( fs ) delete (IDisposable^)fs; } }
for reading from and writing to the specified file. Associated enumerations: FileIOPermissionAccess::Read, FileIOPermissionAccess::Write
Available since 10
.NET Framework
Available since 1.1
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0