UdpClient.Available プロパティ

.NET Framework クラス ライブラリ リファレンス

UdpClient.Available プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

読み取りが可能なネットワークから受信したデータの量を取得します。

名前空間: System.Net.Sockets
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public ReadOnly Property
 Available As Integer

Visual Basic (使用法)

Dim instance As UdpClient
Dim value As Integer

value = instance.Available

C#

public int Available { get;
 }

C++

public:
property int Available {
    int get ();
}

J#

/** @property */
public int get_Available ()

JScript

public function get Available
 () : int

プロパティ値
ネットワークから受信したデータのバイト数。

例外

例外の種類	条件
SocketException	ソケットへのアクセスを試みているときにエラーが発生しました。詳細については「解説」を参照してください。
ObjectDisposedException	Socket は閉じられています。

解説

Available プロパティは、読み取り用のネットワーク バッファのキューに置かれているデータの量を確認するために使用されます。データがある場合は、Read を呼び出してデータを取得します。使用できるデータがない場合、Available プロパティは 0 を返します。

リモート ホストがシャットダウンするか接続を閉じると、Available プロパティは SocketException をスローします。

メモ
SocketException が発生した場合は、SocketException.ErrorCode を使用して特定のエラー コードを取得してください。エラーの詳細については、MSDN ライブラリ (http://msdn.microsoft.com/library/ja/) で Windows Socket Version 2 API のエラー コードのドキュメントを参照してください。

使用例

Available プロパティを使用するコード例を次に示します。

C#

public static void GetAvailable(UdpClient
 u)
{
    // Get the number of bytes available for reading.
    Console.WriteLine("Available value is {0}",
        u.Available);
}

C++

static void GetAvailable( UdpClient^ u )
{
   // Get the number of bytes available for reading.
   Console::WriteLine(  "Available value is {0}", u->Available );
}

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
UdpClient クラス
UdpClient メンバ
System.Net.Sockets 名前空間