SerialPort.WriteTimeout プロパティ

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

SerialPort.WriteTimeout プロパティ

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

書き込み操作が完了していないときに、タイムアウトになるまでのミリ秒数を取得または設定します。

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

Visual Basic (宣言)

Public Property WriteTimeout As
 Integer

Visual Basic (使用法)

Dim instance As SerialPort
Dim value As Integer

value = instance.WriteTimeout

instance.WriteTimeout = value

C#

public int WriteTimeout { get;
 set; }

C++

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

J#

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

/** @property */
public void set_WriteTimeout (int
 value)

JScript

public function get WriteTimeout
 () : int

public function set WriteTimeout
 (value : int)

プロパティ値
タイムアウトになるまでのミリ秒数。既定値は InfiniteTimeout です。

例外

例外の種類	条件
IOException	ポートが無効状態です。 または 基本ポートの状態を設定しようとしましたが失敗しました。たとえば、この SerialPort オブジェクトから渡されたパラメータが無効であるなどです。
ArgumentOutOfRangeException	WriteTimeout 値が 0 未満であり、InfiniteTimeout と等しくありません。

解説

Win32 Communications API では、書き込みタイムアウト値は、本来 500 ミリ秒に設定されていました。このプロパティを使用すると、この値を設定できます。この値を 0 に設定すると、書き込み操作から即座に返すことができます。また、正の値や InfiniteTimeout (既定値) にも設定できます。このプロパティは、BaseStream の BeginWrite メソッドには影響を与えません。

使用例

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 名前空間