NetworkStream.Read メソッド

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

NetworkStream.Read メソッド

NetworkStream からデータを読み取ります。

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

Visual Basic (宣言)

Public Overrides Function
 Read ( _
    <InAttribute> <OutAttribute> buffer As Byte(),
 _
    offset As Integer, _
    size As Integer _
) As Integer

Visual Basic (使用法)

Dim instance As NetworkStream
Dim buffer As Byte()
Dim offset As Integer
Dim size As Integer
Dim returnValue As Integer

returnValue = instance.Read(buffer, offset, size)

C#

public override int Read (
    [InAttribute] [OutAttribute] byte[] buffer,
    int offset,
    int size
)

C++

public:
virtual int Read (
    [InAttribute] [OutAttribute] array<unsigned char>^ buffer,
 
    int offset, 
    int size
) override

J#

public int Read (
    /** @attribute InAttribute() */ /** @attribute OutAttribute() */ byte[] buffer,
 
    int offset, 
    int size
)

JScript

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

パラメータ

buffer

Byte 型の配列。NetworkStream から読み取られたデータを格納するメモリ内の場所です。

offset

データの格納を開始する buffer 内の場所。

size

NetworkStream から読み取るバイト数。

戻り値
NetworkStream から読み取るバイト数。

例外

例外の種類	条件
ArgumentNullException	buffer が null 参照 (Visual Basic では Nothing) です。
ArgumentOutOfRangeException	offset が 0 未満です。 または offset が buffer の長さを超えています。 または size が 0 未満です。 または size が、buffer の長さから offset パラメータの値を引いた値を超えています。 または ソケットへのアクセス中にエラーが発生しました。詳細については「解説」を参照してください。
IOException	基になっている Socket が閉じています。
ObjectDisposedException	NetworkStream が閉じています。 または ネットワークからの読み取りでエラーが発生しました。

解説

このメソッドは、データを buffer パラメータに読み込み、正常に読み込まれたバイト数を返します。読み取ることができるデータが存在しない場合、Read メソッドは 0 を返します。Read 操作は、size パラメータで指定されたバイト数に達するまで、使用できるデータをすべて読み取ります。リモート ホストが接続をシャットダウンし、使用できるデータがすべて受信されると、Read メソッドはすぐに完了して、0 バイトを返します。

メモ
CanRead プロパティを呼び出して、NetworkStream が読み取り可能かどうかを確認します。読み取ることができない NetworkStream からデータを読み取ろうとすると、IOException が発生します。

メモ
IOException が発生した場合は、InnerException プロパティをチェックして、この原因が SocketException かどうかを確認してください。その場合、ErrorCode プロパティを使用して特定のエラー コードを取得してください。エラーの詳細については、MSDN で Windows Socket Version 2 API のエラー コードのドキュメントを参照してください。

使用例

DataAvailable を使用し、読み取り対象のデータがあるかどうかを確認するコード例を次に示します。データがある場合は、NetworkStream から読み取ります。

Visual Basic

' Check to see if this NetworkStream is readable.
If myNetworkStream.CanRead Then
   Dim myReadBuffer(1024) As Byte
       Dim myCompleteMessage As StringBuilder
 = New StringBuilder()
   Dim numberOfBytesRead As Integer
 = 0
   
   ' Incoming message may be larger than the buffer size.
   Do
      numberOfBytesRead = myNetworkStream.Read(myReadBuffer, 0, myReadBuffer.Length)
           myCompleteMessage.AppendFormat("{0}", Encoding.ASCII.GetString(myReadBuffer,
 0, numberOfBytesRead))
   Loop While myNetworkStream.DataAvailable
   
   ' Print out the received message to the console.
       Console.WriteLine(("You received the following message
 : " + myCompleteMessage.ToString()))
Else
   Console.WriteLine("Sorry.  You cannot read from this NetworkStream.")
End If

C#

           
// Check to see if this NetworkStream is readable.
if(myNetworkStream.CanRead){
    byte[] myReadBuffer = new byte[1024];
    StringBuilder myCompleteMessage = new StringBuilder();
    int numberOfBytesRead = 0;

    // Incoming message may be larger than the buffer size.
    do{
         numberOfBytesRead = myNetworkStream.Read(myReadBuffer, 0, myReadBuffer.Length);

         myCompleteMessage.AppendFormat("{0}", Encoding.ASCII.GetString(myReadBuffer,
 0, numberOfBytesRead));
                         
    }
    while(myNetworkStream.DataAvailable);

    // Print out the received message to the console.
    Console.WriteLine("You received the following message : " +
                                 myCompleteMessage);
}
else{
     Console.WriteLine("Sorry.  You cannot read from this
 NetworkStream.");
}

C++

// Check to see if this NetworkStream is readable.
if ( myNetworkStream->CanRead )
{
   array<Byte>^ myReadBuffer = gcnew array<Byte>(1024);
   String^ myCompleteMessage = "";
   int numberOfBytesRead = 0;
   
   // Incoming message may be larger than the buffer size.
   do
   {
      numberOfBytesRead = myNetworkStream->Read( myReadBuffer, 0,
         myReadBuffer->Length );
      myCompleteMessage = String::Concat( myCompleteMessage,
         Encoding::ASCII->GetString( myReadBuffer, 0, numberOfBytesRead ) );
   }
   while ( myNetworkStream->DataAvailable );
   
   // Print out the received message to the console.
   Console::WriteLine( "You received the following message : {0}",
      myCompleteMessage );
}
else
{
   Console::WriteLine( "Sorry.  You cannot read from this
 NetworkStream." );
}

J#

// Check to see if this NetworkStream is readable.
if (myNetworkStream.get_CanRead()) {
    ubyte myReadBuffer[] = new ubyte[1024];
    String myCompleteMessage = "";
    int numberOfBytesRead = 0;
    // Incoming message may be larger than the buffer size.
    do {
        numberOfBytesRead = myNetworkStream.Read(myReadBuffer,
            0, myReadBuffer.get_Length());
        myCompleteMessage = String.Concat(myCompleteMessage, 
            Encoding.get_ASCII().GetString(myReadBuffer, 0, 
            numberOfBytesRead));
    } while (myNetworkStream.get_DataAvailable());
    // Print out the received message to the console.
    Console.WriteLine("You received the following message : " 
        + myCompleteMessage);
}
else {
    Console.WriteLine("Sorry.  You cannot read from this
 "
        + "NetworkStream.");
}

プラットフォーム

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、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
NetworkStream クラス
NetworkStream メンバ
System.Net.Sockets 名前空間
Receive
DataAvailable
CanRead
その他の技術情報
ネットワークでのストリームの使用