Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

FileStream Class

When it is called by an elevated-trust application, exposes a Stream around a file, supporting both synchronous and asynchronous read and write operations.

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

[ComVisibleAttribute(true)]
public class FileStream : Stream

The FileStream type exposes the following members.

  NameDescription
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360FileStream(String, FileMode)When it is called by trusted applications, initializes a new instance of the FileStream class with the specified path and creation mode.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360FileStream(String, FileMode, FileAccess)When it is called by trusted applications, initializes a new instance of the FileStream class with the specified path, creation mode, and read/write permission.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360FileStream(String, FileMode, FileAccess, FileShare)When it is called by trusted applications, initializes a new instance of the FileStream class with the specified path, creation mode, read/write permission, and sharing permission.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360FileStream(String, FileMode, FileAccess, FileShare, Int32)When it is called by trusted applications, initializes a new instance of the FileStream class with the specified path, creation mode, read/write and sharing permission, and buffer size.
Top

  NameDescription
Public propertySupported by Silverlight for Windows PhoneSupported by Xbox 360CanReadGets a value indicating whether the current stream supports reading. (Overrides Stream.CanRead.)
Public propertySupported by Silverlight for Windows PhoneSupported by Xbox 360CanSeekGets a value indicating whether the current stream supports seeking. (Overrides Stream.CanSeek.)
Public propertySupported by Silverlight for Windows PhoneSupported by Xbox 360CanTimeoutGets a value that determines whether the current stream can time out. (Inherited from Stream.)
Public propertySupported by Silverlight for Windows PhoneSupported by Xbox 360CanWriteGets a value indicating whether the current stream supports writing. (Overrides Stream.CanWrite.)
Public propertySupported by Silverlight for Windows PhoneSupported by Xbox 360LengthWhen it is called by trusted applications, gets the length in bytes of the stream. (Overrides Stream.Length.)
Public propertySupported by Silverlight for Windows PhoneSupported by Xbox 360NameWhen it is called by trusted applications, gets the name of the file stream that was passed to the constructor.
Public propertySupported by Silverlight for Windows PhoneSupported by Xbox 360PositionWhen it is called by trusted applications, gets or sets the current position of this stream. (Overrides Stream.Position.)
Public propertySupported by Silverlight for Windows PhoneSupported by Xbox 360ReadTimeoutGets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out. (Inherited from Stream.)
Public propertySupported by Silverlight for Windows PhoneSupported by Xbox 360WriteTimeoutGets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out. (Inherited from Stream.)
Top

  NameDescription
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360BeginReadBegins an asynchronous read. (Overrides Stream.BeginRead(Byte[], Int32, Int32, AsyncCallback, Object).)
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360BeginWriteBegins an asynchronous write. (Overrides Stream.BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object).)
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360CloseCloses the current stream and releases any resources (such as sockets and file handles) associated with the current stream. (Inherited from Stream.)
Public methodSupported by Silverlight for Windows PhoneCopyTo(Stream)Reads all the bytes from the current stream and writes them to the destination stream. (Inherited from Stream.)
Public methodSupported by Silverlight for Windows PhoneCopyTo(Stream, Int32)Reads all the bytes from the current stream and writes them to a destination stream, using a specified buffer size. (Inherited from Stream.)
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360Dispose()Releases all resources used by the Stream. (Inherited from Stream.)
Protected methodSupported by Silverlight for Windows PhoneSupported by Xbox 360Dispose(Boolean)Releases the unmanaged resources used by the FileStream and optionally releases the managed resources. (Overrides Stream.Dispose(Boolean).)
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360EndReadWaits for the pending asynchronous read to complete. (Overrides Stream.EndRead(IAsyncResult).)
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360EndWriteEnds an asynchronous write, blocking until the I/O operation has completed. (Overrides Stream.EndWrite(IAsyncResult).)
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360Equals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows PhoneSupported by Xbox 360FinalizeEnsures that resources are freed and other cleanup operations are performed when the garbage collector reclaims the FileStream. (Overrides Object.Finalize().)
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360Flush()Clears all buffers for this stream and causes any buffered data to be written to the file system. (Overrides Stream.Flush().)
Public methodSupported by Silverlight for Windows PhoneFlush(Boolean)Clears buffers for this stream and causes any buffered data to be written to the file, and also clears all intermediate file buffers.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360GetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360GetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows PhoneSupported by Xbox 360MemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360ReadReads a block of bytes from the stream and writes the data in a given buffer. (Overrides Stream.Read(Byte[], Int32, Int32).)
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360ReadByteReads a byte from the file and advances the read position one byte. (Overrides Stream.ReadByte().)
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360SeekSets the current position of this stream to the given value. (Overrides Stream.Seek(Int64, SeekOrigin).)
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360SetLengthSets the length of this stream to the given value. (Overrides Stream.SetLength(Int64).)
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360ToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteWrites a block of bytes to this stream using data from a buffer. (Overrides Stream.Write(Byte[], Int32, Int32).)
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteByteWrites a byte to the current position in the file stream. (Overrides Stream.WriteByte(Byte).)
Top

Platform Notes

Silverlight for Windows Phone Silverlight for Windows Phone

This type is present to support the .NET Compact Framework infrastructure in Silverlight for Windows Phone, and it is not intended to be used in your application code.

The following example displays an image picked at random from the user's My Pictures folder. It uses the DirectoryInfo class to obtain an enumerable collection of FileInfo objects that represent files that have a .jpg or .png extension. That collection is used to construct a List<T> collection so that an index can be used to select a file that corresponds to the random number.

The example then creates a bitmap image by using the FileStream class and sets it as the source for an Image control (named MyImage).

For example code and information about how to create an application that runs outside the browser, see Out-of-Browser Support.


private void LoadImage()
{

	if (Application.Current.HasElevatedPermissions)
	{
		DirectoryInfo di = new DirectoryInfo(Environment.GetFolderPath(
		   Environment.SpecialFolder.MyPictures));

		var files = from f in di.EnumerateFiles()
					where f.Extension.ToLower() == ".jpg" || 
						f.Extension == ".png"
					select f;

		int max = files.Count() + 1;

		Random rnd = new Random();
		int r = rnd.Next(0, max);

		List<FileInfo> pics = new List<FileInfo>(files);

		string randpic = pics[r].FullName;

		BitmapImage img = new BitmapImage();
		img.SetSource(new FileStream(randpic, FileMode.Open));

		MyImage.Source = img;

	}
}


Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

Show:
© 2014 Microsoft