FileStream Constructor (String, FileMode, FileAccess, FileShare, Int32, FileOptions)
Assembly: mscorlib (in mscorlib.dll)
public FileStream ( string path, FileMode mode, FileAccess access, FileShare share, int bufferSize, FileOptions options )
public FileStream ( String path, FileMode mode, FileAccess access, FileShare share, int bufferSize, FileOptions options )
public function FileStream ( path : String, mode : FileMode, access : FileAccess, share : FileShare, bufferSize : int, options : FileOptions )
Parameters
- path
A relative or absolute path for the file that the current FileStream object will encapsulate.
- mode
A FileMode constant that determines how to open or create the file.
- access
A FileAccess constant that determines how the file can be accessed by the FileStream object. This gets the CanRead and CanWrite properties of the FileStream object. CanSeek is true if path specifies a disk file.
- share
A FileShare constant that determines how the file will be shared by processes.
- bufferSize
A positive Int32 value greater than 0 indicating the buffer size. For bufferSize values between zero and eight, the actual buffer size is set to eight bytes.
- options
A FileOptions value that specifies additional file options.
| Exception type | Condition |
|---|---|
| path is a null reference (Nothing in Visual Basic). | |
| path is an empty string (""), contains only white space, or contains one or more invalid characters. -or- path refers to a non-file device, such as "con:", "com1:", "lpt1:", etc. in an NTFS environment. | |
| path refers to a non-file device, such as "con:", "com1:", "lpt1:", etc. in a non-NTFS environment. | |
ArgumentException | path is an empty string (""), contains only white space, or contains one or more invalid characters. |
| bufferSize is negative or zero. -or- mode, access, or share contain an invalid value. | |
| The file cannot be found, such as when mode is FileMode.Truncate or FileMode.Open, and the file specified by path does not exist. The file must already exist in these modes. | |
| An I/O error occurs, such as specifying FileMode.CreateNew and the file specified by path already exists. -or- The stream has been closed. | |
| The caller does not have the required permission. | |
| The specified path is invalid, such as being on an unmapped drive. | |
| The access requested is not permitted by the operating system for the specified path, such as when access is Write or ReadWrite and the file or directory is set for read-only access. | |
| 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. |
The .NET Framework does not support direct access to physical disks through paths that are device names, such as "\\.\PHYSICALDRIVE0 ".
The fileOptions parameter is used to provide access to more advanced operations that can be leveraged when creating a FileStream object.
The path parameter can be a file name, including a file on a Universal Naming Convention (UNC) share.
Note |
|---|
| path is not required to be a file stored on disk; it can be any part of a system that supports access through streams. For example, depending on the system, this class can access a physical device. |
CanSeek is true for all FileStream objects that encapsulate files. If path indicates a device that does not support seeking, the CanSeek property on the resulting FileStream is false. For additional information, see CanSeek.
Caution |
|---|
| When you compile a set of characters with a particular cultural setting and retrieve those same characters with a different cultural setting, the characters might not be interpretable, and could cause an exception to be thrown. |
The following table lists examples of other typical or related I/O tasks.
| To do this... | See the example in this topic... |
|---|---|
| Create a text file. | |
| Write to a text file. | |
| Read from a text file. | |
| Append text to a file. | |
| Rename or move a file. | |
| Delete a file. | |
| Copy a file. | |
| Get the size of a file. | |
| Get the attributes of a file. | |
| Set the attributes of a file. | |
| Determine if a file exists. | |
| Read from a binary file. | |
| Write to a binary file. | |
| Retrieve a file extension. | |
| Retrieve the fully qualified path of a file. | |
| Retrieve the file name and extension from a path. | |
| Change the extension of a file. |
The following example writes data to a file and then reads the data using the FileStream object.
using System; using System.IO; using System.Text; using System.Security.AccessControl; namespace FileSystemExample { class FileStreamExample { public static void Main() { try { // Create a file and write data to it. // Create an array of bytes. byte[] messageByte = Encoding.ASCII.GetBytes("Here is some data."); // Create a file using the FileStream class. FileStream fWrite = new FileStream("test.txt", FileMode.Create, FileAccess.ReadWrite, FileShare.None, 8, FileOptions.None); // Write the number of bytes to the file. fWrite.WriteByte((byte)messageByte.Length); // Write the bytes to the file. fWrite.Write(messageByte, 0, messageByte.Length); // Close the stream. fWrite.Close(); // Open a file and read the number of bytes. FileStream fRead = new FileStream("test.txt", FileMode.Open); // The first byte is the string length. int length = (int)fRead.ReadByte(); // Create a new byte array for the data. byte[] readBytes = new byte[length]; // Read the data from the file. fRead.Read(readBytes, 0, readBytes.Length); // Close the stream. fRead.Close(); // Display the data. Console.WriteLine(Encoding.ASCII.GetString(readBytes)); Console.WriteLine("Done writing and reading data."); } catch (Exception e) { Console.WriteLine(e); } Console.ReadLine(); } } }
- FileIOPermission for reading, writing, and appending to files. Associated enumerations: FileIOPermissionAccess.Read, FileIOPermissionAccess.Write, and FileIOPermissionAccess.Append.
Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.
Note