SerialPort.Handshake プロパティ

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

SerialPort.Handshake プロパティ

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

データのシリアル ポート伝送のハンドシェイク プロトコルを取得または設定します。

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

Visual Basic (宣言)

Public Property Handshake As
 Handshake

Visual Basic (使用法)

Dim instance As SerialPort
Dim value As Handshake

value = instance.Handshake

instance.Handshake = value

C#

public Handshake Handshake { get; set;
 }

C++

public:
property Handshake Handshake {
    Handshake get ();
    void set (Handshake value);
}

J#

/** @property */
public Handshake get_Handshake ()

/** @property */
public void set_Handshake (Handshake value)

JScript

public function get Handshake
 () : Handshake

public function set Handshake
 (value : Handshake)

プロパティ値
Handshake 値の 1 つ。既定値は None です。

例外

例外の種類	条件
IOException	ポートが無効状態です。 または 基本ポートの状態を設定しようとしましたが失敗しました。たとえば、この SerialPort オブジェクトから渡されたパラメータが無効であるなどです。
ArgumentOutOfRangeException	渡された値は、Handshake 列挙体の有効値ではありません。
InvalidOperationException	ストリームが閉じられました。これは、Open メソッドが呼び出されていないか、Close メソッドが呼び出されたことが原因で発生する場合があります。

解説

ハンドシェイクの使用時には、SerialPort オブジェクトに接続されたデバイスは、バッファ内に少なくとも (ReadBufferSize-1024) バイト存在しないと、データの送信を中止するよう指示されます。バッファ内に 1024 以下のバイトが存在する場合、デバイスはデータの送信を再び開始するよう指示されます。デバイスが 1024 バイトを上回るブロック内のデータを送信した場合、バッファ オーバーフローの原因になる可能性があります。

Handshake プロパティに RequestToSendXOnXOff が設定され、CtsHolding に false が設定されている場合、XOff 文字は送信されません。CtsHolding に true が設定されている場合は、XOff 文字を送信する前により多くのデータを送信する必要があります。

使用例

SerialPort クラスを使用して、ヌル モデム ケーブルで接続された 2 台のコンピュータで 2 人のユーザーがチャットできるようにするための方法を次のコード例に示します。この例では、ユーザーはチャットを行う前にポート設定とユーザー名の入力を求められます。このコード例は、SerialPort クラスのトピックで取り上げている、コード例の一部分です。

プラットフォーム

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

参照

関連項目
SerialPort クラス
SerialPort メンバ
System.IO.Ports 名前空間