FileShare Enumeration (System.IO)

Switch View

FileShare Enumeration

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

FileShare Enumeration

Contains constants for controlling the kind of access other FileStream objects can have to the same file.

This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.

Namespace: System.IO
Assembly: mscorlib (in mscorlib.dll)

Syntax

Visual Basic (Declaration)

<SerializableAttribute> _
<FlagsAttribute> _
<ComVisibleAttribute(True)> _
Public Enumeration FileShare

Visual Basic (Usage)

Dim instance As FileShare

[SerializableAttribute]
[FlagsAttribute]
[ComVisibleAttribute(true)]
public enum FileShare

Visual C++

[SerializableAttribute]
[FlagsAttribute]
[ComVisibleAttribute(true)]
public enum class FileShare

JScript

public enum FileShare

Members

	Member name	Description
	None	Declines sharing of the current file. Any request to open the file (by this process or another process) will fail until the file is closed.
	Read	Allows subsequent opening of the file for reading. If this flag is not specified, any request to open the file for reading (by this process or another process) will fail until the file is closed. However, even if this flag is specified, additional permissions might still be needed to access the file.
	Write	Allows subsequent opening of the file for writing. If this flag is not specified, any request to open the file for writing (by this process or another process) will fail until the file is closed. However, even if this flag is specified, additional permissions might still be needed to access the file.
	ReadWrite	Allows subsequent opening of the file for reading or writing. If this flag is not specified, any request to open the file for reading or writing (by this process or another process) will fail until the file is closed. However, even if this flag is specified, additional permissions might still be needed to access the file.
	Delete	Allows subsequent deleting of a file.
	Inheritable	Makes the file handle inheritable by child processes. This is not directly supported by Win32.

Remarks

For an example of creating a file and writing text to a file, see How to: Write Text to a File. For an example of reading text from a file, see How to: Read Text from a File. For an example of reading from and writing to a binary file, see How to: Read and Write to a Newly Created Data File.

A typical use of this enumeration is to define whether two processes can simultaneously read from the same file. For example, if a file is opened and Read is specified, other users can open the file for reading but not for writing.

A FileShare parameter is specified in some of the constructors for FileStream, IsolatedStorageFileStream, and in some of the Open methods of File and FileInfo to control how a file is opened.

Examples

The following FileStream constructor opens an existing file and grants read-only access to other users (Read).

Visual Basic

Dim s2 As New FileStream(name, FileMode.Open, FileAccess.Read, FileShare.Read)

FileStream s2 = new FileStream(name, FileMode.Open, FileAccess.Read, FileShare.Read);

Visual C++

FileStream^ s2 = gcnew FileStream( name, FileMode::Open, FileAccess::Read, FileShare::Read );

JScript

var s2 : FileStream = new FileStream(name, FileMode.Open, FileAccess.Read, FileShare.Read);

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0

Reference

IsolatedStorageFileStream

Other Resources

File and Stream I/O

How to: Read Text from a File

How to: Write Text to a File

Basic File I/O

How to: Read and Write to a Newly Created Data File