IOCTL_SERIAL_GET_WAIT_MASK IOCTL (ntddser.h)

  • [アーティクル]

IOCTL_SERIAL_GET_WAIT_MASK要求は、シリアル コントローラーに対して現在設定されているイベント待機マスクを返します。

クライアントは、SERIAL_EV_EVENT2を介して SERIAL_EV_RXCHAR フラグ ビットによって表される待機イベント を待機できます。 これらのイベント フラグの詳細については、「解説」セクションを参照してください。

イベント待機マスクを設定するために、クライアントは IOCTL_SERIAL_SET_WAIT_MASK 要求を使用できます。 待機イベントが発生するのを待機するために、クライアントは IOCTL_SERIAL_WAIT_ON_MASK 要求を使用します。

メジャー コード

IRP_MJ_DEVICE_CONTROL

[入力バッファー]

[なし] :

入力バッファーの長さ

[なし] :

出力バッファー

AssociatedIrp.SystemBuffer メンバーは、シリアル コントローラー ドライバーが待機マスクの出力に使用するクライアント割り当て ULONG バッファーを指します。 待機マスクは、0 であるか、1 つ以上の SERIAL_EV_XXX イベント フラグのビットごとの OR です。

出力バッファーの長さ

Parameters.DeviceIoControl.OutputBufferLength メンバーは、ULONG のサイズ (バイト単位) に設定されます。

ステータス ブロック

要求が成功した場合、 Information メンバーは ULONG のサイズ (バイト単位) に設定されます。 それ以外の場合、 Information メンバーは 0 に設定されます。

Status メンバーは、シリアル デバイス制御要求の汎用状態値のいずれかに設定されます。

注釈

SERIAL_EV_XXX 定数は、シリアル ポートの待機マスク内のフラグ ビットを定義します。

#define SERIAL_EV_RXCHAR     0x0001
#define SERIAL_EV_RXFLAG     0x0002
#define SERIAL_EV_TXEMPTY    0x0004
#define SERIAL_EV_CTS        0x0008
#define SERIAL_EV_DSR        0x0010
#define SERIAL_EV_RLSD       0x0020
#define SERIAL_EV_BREAK      0x0040
#define SERIAL_EV_ERR        0x0080
#define SERIAL_EV_RING       0x0100
#define SERIAL_EV_PERR       0x0200
#define SERIAL_EV_RX80FULL   0x0400
#define SERIAL_EV_EVENT1     0x0800
#define SERIAL_EV_EVENT2     0x1000

SERIAL_EV_XXX 定数は、待機マスクで指定できるイベントの種類を定義します。 クライアント (アプリケーションまたは周辺機器ドライバー) がシリアル ポートへの接続を開いた後、クライアントは、クライアントが監視する必要があるイベントの種類を示す待機マスクを指定できます。 これらのイベントは、シリアル ポートのハードウェア状態の変化です。 待機マスク内のイベントが発生すると、クライアントに通知されます。

IOCTL_SERIAL_SET_WAIT_MASKおよびIOCTL_SERIAL_GET_WAIT_MASK制御要求では、イベント待機マスクを使用して、クライアントが待機できる一連のイベントを指定します。 待機マスク値は、0 または 1 つ以上の SERIAL_EV_XXX 定数のビットごとの OR です。 待機マスク値 0 は、クライアントがイベントを待機しないことを示します。

クライアントは、現在設定されている待機マスク内のイベントを待機するために、 IOCTL_SERIAL_WAIT_ON_MASK 制御要求を送信します。 シリアル コントローラー ドライバーは、待機マスク内のイベントが発生したときに、この要求を完了します。

次の表は、SerCx2、SerCx、および Serial.sys でサポートされているSERIAL_EV_XXX フラグ ビットを示しています。 テーブルの Yes エントリは、シリアル フレームワーク拡張機能またはドライバーが対応するフラグ ビットをサポートしていることを示します。 No エントリは、フラグ ビットがサポートされていないことを示します。

フラグ ビット SerCx2 SerCx Serial.sys
SERIAL_EV_RXCHAR Yes Yes Yes
SERIAL_EV_RXFLAG 「注」を参照してください。 いいえ Yes
SERIAL_EV_TXEMPTY Yes Yes Yes
SERIAL_EV_CTS Yes Yes Yes
SERIAL_EV_DSR Yes Yes Yes
SERIAL_EV_RLSD 「注」を参照してください。 Yes Yes
SERIAL_EV_BREAK Yes Yes Yes
SERIAL_EV_ERR Yes Yes Yes
SERIAL_EV_RING 「注」を参照してください。 Yes Yes
SERIAL_EV_PERR 「注」を参照してください。 いいえ いいえ
SERIAL_EV_RX80FULL 「注」を参照してください。 いいえ Yes
SERIAL_EV_EVENT1 「注」を参照してください。 いいえ いいえ
SERIAL_EV_EVENT2 「注」を参照してください。 いいえ いいえ
 
メモ SerCx2 は、シリアル コントローラー ドライバーとシリアル コントローラー ハードウェアの機能に応じて、指定されたテーブル エントリのフラグ ビットをサポートする場合とサポートされていない場合があります。
 
SerCx2、SerCx、および Serial.sys の詳細については、「 シリアル コントローラー ドライバーの概要」を参照してください。

要件

要件 値
Header ntddser.h (Ntddser.h を含む)

こちらもご覧ください

IOCTL_SERIAL_GET_CHARS

IOCTL_SERIAL_SET_CHARS

IOCTL_SERIAL_SET_WAIT_MASK

IOCTL_SERIAL_WAIT_ON_MASK

SERIAL_CHARS

SERIAL_STATUS