Socket.ReceiveMessageFrom メソッド

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

Socket.ReceiveMessageFrom メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

指定した SocketFlags を使用し、指定したバイト数のデータを受信して、データ バッファ内の指定した位置に格納します。さらに、エンドポイントとパケット情報を格納します。

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

Visual Basic (宣言)

Public Function ReceiveMessageFrom ( _
    buffer As Byte(), _
    offset As Integer, _
    size As Integer, _
    ByRef socketFlags As SocketFlags, _
    ByRef remoteEP As EndPoint, _
    <OutAttribute> ByRef ipPacketInformation As
 IPPacketInformation _
) As Integer

Visual Basic (使用法)

Dim instance As Socket
Dim buffer As Byte()
Dim offset As Integer
Dim size As Integer
Dim socketFlags As SocketFlags
Dim remoteEP As EndPoint
Dim ipPacketInformation As IPPacketInformation
Dim returnValue As Integer

returnValue = instance.ReceiveMessageFrom(buffer, offset, size, socketFlags, remoteEP,
 ipPacketInformation)

C#

public int ReceiveMessageFrom (
    byte[] buffer,
    int offset,
    int size,
    ref SocketFlags socketFlags,
    ref EndPoint remoteEP,
    out IPPacketInformation ipPacketInformation
)

C++

public:
int ReceiveMessageFrom (
    array<unsigned char>^ buffer, 
    int offset, 
    int size, 
    SocketFlags% socketFlags, 
    EndPoint^% remoteEP, 
    [OutAttribute] IPPacketInformation% ipPacketInformation
)

J#

public int ReceiveMessageFrom (
    byte[] buffer, 
    int offset, 
    int size, 
    /** @ref */ SocketFlags socketFlags, 
    /** @ref */ EndPoint remoteEP, 
    /** @attribute OutAttribute() */ /** @ref */ IPPacketInformation ipPacketInformation
)

JScript

JScript では、値型の引数は参照渡しされません。

パラメータ

buffer

受信したデータのストレージ場所となる Byte 型の配列。

offset

受信データを格納する bufferパラメータ内の位置。

size

受信するバイト数。

socketFlags

SocketFlags 値のビットごとの組み合わせ。

remoteEP

リモート サーバーを表す、参照渡しされた EndPoint。

ipPacketInformation

アドレス情報とインターフェイス情報を保持している IPPacketInformation。

戻り値
受信したバイト数。

例外

例外の種類	条件
ArgumentNullException	buffer が null 参照 (Visual Basic では Nothing) です。 または remoteEP が null 参照 (Visual Basic では Nothing) です。
ArgumentOutOfRangeException	offset が 0 未満です。 または offset が buffer の長さを超えています。 または size が 0 未満です。 または size が、buffer の長さからオフセット パラメータの値を引いた値を超えています。
SocketException	socketFlags が、値の有効な組み合わせではありません。 または LocalEndPoint プロパティが設定されていませんでした。 または .NET Framework が、AMD 64 ビット プロセッサ上で実行されています。 または ソケットへのアクセスを試みているときにエラーが発生しました。詳細については「解説」を参照してください。
ObjectDisposedException	Socket は閉じられています。
NotSupportedException	Windows 2000 以前のオペレーティング システムです。このメソッドを使用するには、Windows XP が必要です。

解説

ReceiveMessageFrom メソッドは、buffer パラメータにデータを読み込み、正常に読み込まれたバイト数を返し、データの送信元のリモート ホスト エンドポイントと受信パケットに関する情報をキャプチャします。

データグラムが、ユニキャスト、マルチキャスト、またはブロードキャストのどれを使用して送信されたのかを区別する必要がある場合は、ipPacketInformation を調べます。

メモ
ReceiveFrom に使用する EndPoint の AddressFamily は、SendTo に使用する EndPoint の AddressFamily と一致させる必要があります。

メモ
このメンバは、アプリケーションでネットワーク トレースが有効にされている場合にトレース情報を出力します。詳細については、「ネットワークのトレース」を参照してください。

.NET Framework のセキュリティ

• SocketPermission  (ネットワークからの接続を受け入れるために必要なアクセス許可)Accept (関連する列挙体)

プラットフォーム

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

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

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
Socket クラス
Socket メンバ
System.Net.Sockets 名前空間
Connect
ReceiveFrom
Available
Shutdown
Close