TcpClient.Available Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets the amount of data that has been received from the network and is available to be read.

Namespace:   System.Net.Sockets
Assembly:  System (in System.dll)

Public ReadOnly Property Available As Integer

Property Value

Type: System.Int32

The number of bytes of data received from the network and available to be read.

Exception Condition
SocketException

An error occurred when attempting to access the socket. See the Remarks section for more information.

ObjectDisposedException

The Socket has been closed.

Available is a way to determine whether data is queued for reading. If data is available, call Read to get the data. The available data is the total amount of data queued in the network buffer for reading. If no data is queued in the network buffer, Available returns 0.

If the remote host shuts down or closes the connection, Available may throw a SocketException. If you receive a SocketException, use SocketException.ErrorCode to obtain the specific error code. After you have obtained this code, you can refer to the Windows Sockets version 2 API error code documentation in the MSDN library at http://msdn.microsoft.com/library for a detailed description of the error.

The following code example shows the use of the Available property.

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

.NET Framework
Available since 2.0
Return to top
Show: