UdpClient.Available Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets the amount of data received from the network that is available to read.
public:
property int Available { int get(); };public int Available { get; }member this.Available : intPublic ReadOnly Property Available As IntegerProperty Value
The number of bytes of data received from the network.
Exceptions
An error occurred while attempting to access the socket.
The Socket has been closed.
Examples
The following code example shows the use of the Available property.
static void GetAvailable( UdpClient^ u )
{
// Get the number of bytes available for reading.
Console::WriteLine( "Available value is {0}", u->Available );
}
public static void GetAvailable(UdpClient u)
{
// Get the number of bytes available for reading.
Console.WriteLine("Available value is {0}",
u.Available);
}
Remarks
The Available property is used to determine the amount of data queued in the network buffer for reading. If data is available, call Read to get the data. If no data is available, the Available property returns 0.
If the remote host shuts down or closes the connection, the Available property throws a SocketException.
Note
If you receive a SocketException, use SocketException.ErrorCode to obtain the specific error code and refer to the Windows Sockets version 2 API error code documentation for a detailed description of the error.
