SslStream.Read メソッド

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

SslStream.Read メソッド

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

このストリームからデータを読み取り、指定した配列に格納します。

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

Visual Basic (宣言)

Public Overrides Function
 Read ( _
    buffer As Byte(), _
    offset As Integer, _
    count As Integer _
) As Integer

Visual Basic (使用法)

Dim instance As SslStream
Dim buffer As Byte()
Dim offset As Integer
Dim count As Integer
Dim returnValue As Integer

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

C#

public override int Read (
    byte[] buffer,
    int offset,
    int count
)

C++

public:
virtual int Read (
    array<unsigned char>^ buffer, 
    int offset, 
    int count
) override

J#

public int Read (
    byte[] buffer, 
    int offset, 
    int count
)

JScript

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

パラメータ

buffer

このストリームから読み取ったバイトを受け取る Byte 配列。

offset

このストリームから読み取ったデータの格納を開始する位置を示す、buffer 内のインデックス番号が 0 から始まる位置を格納する Int32。

count

このストリームから読み取る最大バイト数を格納する Int32。

戻り値
読み取るバイト数を指定する Int32 値。読み取るデータがこれ以上存在しない場合は 0 を返します。

例外

例外の種類	条件
ArgumentNullException	buffer が null 参照 (Visual Basic では Nothing) です。
ArgumentException	offset < 0. または offset が buffer の長さを超えています。 または offset と count の合計が buffer の長さを超えています。
IOException	読み取り操作に失敗しました。内部例外が存在する場合は、その例外をチェックしてエラーの原因を確認してください。
NotSupportedException	既に実行中の読み取り操作が存在します。
ObjectDisposedException	このオブジェクトは閉じられています。
InvalidOperationException	認証が行われていません。

解説

このメソッドは、count で指定した最大バイトをストリームから読み取り、buffer 内の offset で始まる位置に格納します。複数の読み取り操作を同時に実行することはできません。

このメソッドは、正常に認証されるまで呼び出すことはできません。認証するには、AuthenticateAsClient、BeginAuthenticateAsClient、AuthenticateAsServer、BeginAuthenticateAsServer のいずれかのメソッドを呼び出します。

この操作を非同期で実行するには、BeginRead メソッドを使用します。

使用例

SslStream から読み取るコード例を次に示します。

C#

static string ReadMessage(SslStream sslStream)
{
    // Read the  message sent by the server.
    // The end of the message is signaled using the
    // "<EOF>" marker.
    byte [] buffer = new byte[2048];
    StringBuilder messageData = new StringBuilder();
    int bytes = -1;
    do
    {
        bytes = sslStream.Read(buffer, 0, buffer.Length);
                
        // Use Decoder class to convert from bytes to UTF8
        // in case a character spans two buffers.
        Decoder decoder = Encoding.UTF8.GetDecoder();
        char[] chars = new char[decoder.GetCharCount(buffer
,0,bytes)];
        decoder.GetChars(buffer, 0, bytes, chars,0);
        messageData.Append (chars);
        // Check for EOF.
        if (messageData.ToString().IndexOf("<EOF>")
 != -1)
        {
            break;
        }
    } while (bytes != 0); 
    
    return messageData.ToString();
}

プラットフォーム

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

参照

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