NegotiateStream.Read Method

Note: This method is new in the .NET Framework version 2.0.

Reads data from this stream and stores it in the specified array.

Namespace: System.Net.Security
Assembly: System (in system.dll)

public override int Read (
	byte[] buffer,
	int offset,
	int count
public int Read (
	byte[] buffer, 
	int offset, 
	int count
public override function Read (
	buffer : byte[], 
	offset : int, 
	count : int
) : int



A Byte array that receives the bytes read from the stream.


A Int32 containing the zero-based location in buffer at which to begin storing the data read from this stream.


A Int32 containing the maximum number of bytes to read from the stream.

Return Value

A Int32 value that specifies the number of bytes read from the underlying stream. When there is no more data to be read, returns 0.

Exception typeCondition


The read operation failed.


Authentication has not occurred.


A Read operation is already in progress.

The method reads a maximum of count bytes from the current stream and stores them in buffer beginning at offset.

You cannot call this method until you have successfully authenticated. To authenticate, call one of the AuthenticateAsClient, BeginAuthenticateAsClient, AuthenticateAsServer, or BeginAuthenticateAsServer methods.

To perform this operation asynchronously, use the BeginRead method.

The following code example demonstrates reading from a NegotiateStream.

public static void AuthenticateClient(TcpClient clientRequest)
    NetworkStream stream = clientRequest.GetStream(); 
    // Create the NegotiateStream.
    NegotiateStream authStream = new NegotiateStream(stream, false);
    // Perform the server side of the authentication.
    // Display properties of the authenticated client.
    IIdentity id = authStream.RemoteIdentity;
    Console.WriteLine("{0} was authenticated using {1}.", 
    // Read a message from the client.
    byte [] buffer = new byte[2048];
    int charLength = authStream.Read(buffer, 0, buffer.Length);
    string messageData = new String(Encoding.UTF8.GetChars(buffer, 0, buffer.Length));
    Console.WriteLine("READ {0}", messageData);
    // Finished with the current client.
    // Close the client connection.

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.

.NET Framework

Supported in: 2.0

Community Additions