SqlFileStream Class
TOC
Collapse the table of content
Expand the table of content

SqlFileStream Class

 

Exposes SQL Server data that is stored with the FILESTREAM column attribute as a sequence of bytes.

Namespace:   System.Data.SqlTypes
Assembly:  System.Data (in System.Data.dll)

System.Object
  System.MarshalByRefObject
    System.IO.Stream
      System.Data.SqlTypes.SqlFileStream

public sealed class SqlFileStream : Stream

NameDescription
System_CAPS_pubmethodSqlFileStream(String, Byte[], FileAccess)

Initializes a new instance of the SqlFileStream class.

System_CAPS_pubmethodSqlFileStream(String, Byte[], FileAccess, FileOptions, Int64)

Initializes a new instance of the SqlFileStream class.

NameDescription
System_CAPS_pubpropertyCanRead

Gets a value indicating whether the current stream supports reading.(Overrides Stream.CanRead.)

System_CAPS_pubpropertyCanSeek

Gets a value indicating whether the current stream supports seeking.(Overrides Stream.CanSeek.)

System_CAPS_pubpropertyCanTimeout

Gets a value indicating whether the current stream can time out.(Overrides Stream.CanTimeout.)

System_CAPS_pubpropertyCanWrite

Gets a value indicating whether the current stream supports writing. (Overrides Stream.CanWrite.)

System_CAPS_pubpropertyLength

Gets a value indicating the length of the current stream in bytes.(Overrides Stream.Length.)

System_CAPS_pubpropertyName

Gets the logical path of the SqlFileStream passed to the constructor.

System_CAPS_pubpropertyPosition

Gets or sets the position within the current stream.(Overrides Stream.Position.)

System_CAPS_pubpropertyReadTimeout

Gets or sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out.(Overrides Stream.ReadTimeout.)

System_CAPS_pubpropertyTransactionContext

Gets or sets the transaction context for this SqlFileStream object.

System_CAPS_pubpropertyWriteTimeout

Gets or sets a value, in milliseconds, that determines how long the stream will attempt to write before timing out.(Overrides Stream.WriteTimeout.)

NameDescription
System_CAPS_pubmethodBeginRead(Byte[], Int32, Int32, AsyncCallback, Object)

Begins an asynchronous read operation.(Overrides Stream.BeginRead(Byte[], Int32, Int32, AsyncCallback, Object).)

System_CAPS_pubmethodBeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)

Begins an asynchronous write operation.(Overrides Stream.BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object).)

System_CAPS_pubmethodClose()

Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream. Instead of calling this method, ensure that the stream is properly disposed.(Inherited from Stream.)

System_CAPS_pubmethodCopyTo(Stream)

Reads the bytes from the current stream and writes them to another stream.(Inherited from Stream.)

System_CAPS_pubmethodCopyTo(Stream, Int32)

Reads the bytes from the current stream and writes them to another stream, using a specified buffer size.(Inherited from Stream.)

System_CAPS_pubmethodCopyToAsync(Stream)

Asynchronously reads the bytes from the current stream and writes them to another stream.(Inherited from Stream.)

System_CAPS_pubmethodCopyToAsync(Stream, Int32)

Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size.(Inherited from Stream.)

System_CAPS_pubmethodCopyToAsync(Stream, Int32, CancellationToken)

Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size and cancellation token.(Inherited from Stream.)

System_CAPS_pubmethodCreateObjRef(Type)

Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodDispose()

Releases all resources used by the Stream.(Inherited from Stream.)

System_CAPS_pubmethodEndRead(IAsyncResult)

Waits for the pending asynchronous read to complete.(Overrides Stream.EndRead(IAsyncResult).)

System_CAPS_pubmethodEndWrite(IAsyncResult)

Ends an asynchronous write operation.(Overrides Stream.EndWrite(IAsyncResult).)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Ensures that resources are freed and other cleanup operations are performed when the garbage collector reclaims the SqlFileStream.(Overrides Object.Finalize().)

System_CAPS_pubmethodFlush()

clears all buffers for this stream and causes any buffered data to be written to the underlying device.(Overrides Stream.Flush().)

System_CAPS_pubmethodFlushAsync()

Asynchronously clears all buffers for this stream and causes any buffered data to be written to the underlying device.(Inherited from Stream.)

System_CAPS_pubmethodFlushAsync(CancellationToken)

Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests.(Inherited from Stream.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodInitializeLifetimeService()

Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodRead(Byte[], Int32, Int32)

Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.(Overrides Stream.Read(Byte[], Int32, Int32).)

System_CAPS_pubmethodReadAsync(Byte[], Int32, Int32)

Asynchronously reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.(Inherited from Stream.)

System_CAPS_pubmethodReadAsync(Byte[], Int32, Int32, CancellationToken)

Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests.(Inherited from Stream.)

System_CAPS_pubmethodReadByte()

Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.(Overrides Stream.ReadByte().)

System_CAPS_pubmethodSeek(Int64, SeekOrigin)

Sets the position within the current stream.(Overrides Stream.Seek(Int64, SeekOrigin).)

System_CAPS_pubmethodSetLength(Int64)

Sets the length of the current stream.(Overrides Stream.SetLength(Int64).)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodWrite(Byte[], Int32, Int32)

Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. (Overrides Stream.Write(Byte[], Int32, Int32).)

System_CAPS_pubmethodWriteAsync(Byte[], Int32, Int32)

Asynchronously writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.(Inherited from Stream.)

System_CAPS_pubmethodWriteAsync(Byte[], Int32, Int32, CancellationToken)

Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.(Inherited from Stream.)

System_CAPS_pubmethodWriteByte(Byte)

Writes a byte to the current position in the stream and advances the position within the stream by one byte.(Overrides Stream.WriteByte(Byte).)

The SqlFileStream class is used to work with varbinary(max) data stored with the FILESTREAM attribute in a SQL Server 2008 database. You must install the .NET Framework 3.5 SP1 (or later) to use N:System.Data.SqlTypes.SqlFileStream to work with FILESTREAM data.

Specifying the FILESTREAM attribute on a varbinary(max) column causes SQL Server to store the data in the local NTFS file system instead of in the database file. Transact-SQL statements provide data manipulation capabilities within the server, and Win32 file system interfaces provide streaming access to the data.

System_CAPS_noteNote

Individual files stored in a FILESTREAM column cannot be opened directly from the NTFS file system. Streaming FILESTREAM data works only in the context of a SQL Server transaction.

The SqlFileStream class is derived from the Stream class, which represents an abstraction of a sequence of bytes from some arbitrary data source such as a file or a block of memory. You can read from a FILESTREAM by transferring data from a stream into a data structure such as an array of bytes. You can write to a FILESTREAM by transferring the data from a data structure into a stream. You can also seek within the stream, which allows you to query and modify data at the current position within the stream.

For conceptual documentation and code examples, see FILESTREAM Data.

For documentation about setting up and configuring FILESTREAM data on SQL Server, see Designing and Implementing FILESTREAM Storage in SQL Server 2008 Books Online.

.NET Framework
Available since 2.0

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

Return to top
Show:
© 2016 Microsoft