CryptoStream Class

 

Defines a stream that links data streams to cryptographic transformations.

Namespace:   System.Security.Cryptography
Assembly:  mscorlib (in mscorlib.dll)

System::Object
  System::MarshalByRefObject
    System.IO::Stream
      System.Security.Cryptography::CryptoStream

[ComVisibleAttribute(true)]
public ref class CryptoStream : Stream, IDisposable

NameDescription
System_CAPS_pubmethodCryptoStream(Stream^, ICryptoTransform^, CryptoStreamMode)

Initializes a new instance of the CryptoStream class with a target data stream, the transformation to use, and the mode of the stream.

NameDescription
System_CAPS_pubpropertyCanRead

Gets a value indicating whether the current CryptoStream is readable.(Overrides Stream::CanRead.)

System_CAPS_pubpropertyCanSeek

Gets a value indicating whether you can seek within the current CryptoStream.(Overrides Stream::CanSeek.)

System_CAPS_pubpropertyCanTimeout

Gets a value that determines whether the current stream can time out.(Inherited from Stream.)

System_CAPS_pubpropertyCanWrite

Gets a value indicating whether the current CryptoStream is writable.(Overrides Stream::CanWrite.)

System_CAPS_pubpropertyHasFlushedFinalBlock

Gets a value indicating whether the final buffer block has been written to the underlying stream.

System_CAPS_pubpropertyLength

Gets the length in bytes of the stream.(Overrides Stream::Length.)

System_CAPS_pubpropertyPosition

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

System_CAPS_pubpropertyReadTimeout

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

System_CAPS_pubpropertyWriteTimeout

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

NameDescription
System_CAPS_pubmethodBeginRead(array<Byte>^, Int32, Int32, AsyncCallback^, Object^)

Begins an asynchronous read operation. (Consider using ReadAsync instead; see the Remarks section.)(Inherited from Stream.)

System_CAPS_pubmethodBeginWrite(array<Byte>^, Int32, Int32, AsyncCallback^, Object^)

Begins an asynchronous write operation. (Consider using WriteAsync instead; see the Remarks section.)(Inherited from Stream.)

System_CAPS_pubmethodClear()

Releases all resources used by the CryptoStream.

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_protmethodCreateWaitHandle()

Obsolete.Allocates a WaitHandle object.(Inherited from Stream.)

System_CAPS_pubmethodDispose()

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

System_CAPS_protmethodDispose(Boolean)

Releases the unmanaged resources used by the CryptoStream and optionally releases the managed resources.(Overrides Stream::Dispose(Boolean).)

System_CAPS_pubmethodEndRead(IAsyncResult^)

Waits for the pending asynchronous read to complete. (Consider using ReadAsync instead; see the Remarks section.)(Inherited from Stream.)

System_CAPS_pubmethodEndWrite(IAsyncResult^)

Ends an asynchronous write operation. (Consider using WriteAsync instead; see the Remarks section.)(Inherited from Stream.)

System_CAPS_pubmethodEquals(Object^)

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

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodFlush()

Clears all buffers for the current 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)

Clears all buffers for the current stream asynchronously, causes any buffered data to be written to the underlying device, and monitors cancellation requests.(Overrides Stream::FlushAsync(CancellationToken).)

System_CAPS_pubmethodFlushFinalBlock()

Updates the underlying data source or repository with the current state of the buffer, then clears the buffer.

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_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone(Boolean)

Creates a shallow copy of the current MarshalByRefObject object.(Inherited from MarshalByRefObject.)

System_CAPS_protmethodObjectInvariant()

Obsolete. This API supports the product infrastructure and is not intended to be used directly from your code. Provides support for a Contract.(Inherited from Stream.)

System_CAPS_pubmethodRead(array<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(array<Byte>^, Int32, Int32).)

System_CAPS_pubmethodReadAsync(array<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(array<Byte>^, Int32, Int32, CancellationToken)

Reads a sequence of bytes from the current stream asynchronously, advances the position within the stream by the number of bytes read, and monitors cancellation requests.(Overrides Stream::ReadAsync(array<Byte>^, Int32, Int32, CancellationToken).)

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.(Inherited from Stream.)

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(array<Byte>^, Int32, Int32)

Writes a sequence of bytes to the current CryptoStream and advances the current position within the stream by the number of bytes written.(Overrides Stream::Write(array<Byte>^, Int32, Int32).)

System_CAPS_pubmethodWriteAsync(array<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(array<Byte>^, Int32, Int32, CancellationToken)

Writes a sequence of bytes to the current stream asynchronously, advances the current position within the stream by the number of bytes written, and monitors cancellation requests.(Overrides Stream::WriteAsync(array<Byte>^, Int32, Int32, CancellationToken).)

System_CAPS_pubmethodWriteByte(Byte)

Writes a byte to the current position in the stream and advances the position within the stream by one byte.(Inherited from Stream.)

The common language runtime uses a stream-oriented design for cryptography. The core of this design is CryptoStream. Any cryptographic objects that implement CryptoStream can be chained together with any objects that implement Stream, so the streamed output from one object can be fed into the input of another object. The intermediate result (the output from the first object) does not need to be stored separately.

System_CAPS_importantImportant

This type implements the IDisposable interface. When you have finished using the type, you should dispose of it either directly or indirectly by calling its Clear method, which in turn calls its IDisposable implementation. To dispose of the type directly, call its Clear method in a try/catch block. To dispose of it indirectly, use a language construct such as using (in C#) or Using (in Visual Basic). For more information, see the “Using an Object that Implements IDisposable” section in the IDisposable interface topic.

You should always explicitly close your CryptoStream object after you are done using it by calling the Clear method. Doing so flushes the underlying stream and causes all remaining blocks of data to be processed by the CryptoStream object. However, if an exception occurs before you call the Close method, the CryptoStream object might not be closed. To ensure that the Close method always gets called, place your call to the Clear method within the finally block of a try/catch statement.

The following example demonstrates how to use a CryptoStream to encrypt a string. This method uses RijndaelManaged class with the specified Key and initialization vector (IV).

No code example is currently available or this language may not be supported.

.NET Framework
Available since 1.1
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.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: