SetCommMask 関数 (winbase.h)

  • [アーティクル]

通信デバイスで監視するイベントのセットを指定します。

構文

BOOL SetCommMask(
  [in] HANDLE hFile,
  [in] DWORD  dwEvtMask
);

パラメーター

[in] hFile

通信デバイスへのハンドル。 CreateFile 関数は、このハンドルを返します。

[in] dwEvtMask

有効にするイベント。 値が 0 の場合、すべてのイベントが無効になります。 このパラメーターには、次の 1 つ以上の値を指定できます。

値 意味
EV_BREAK
0x0040
 入力時にブレークが検出されました。
EV_CTS
0x0008
 CTS (clear-to-send) シグナルの変更状態。
EV_DSR
0x0010
 DSR (データ・セット・レディ) シグナル変更状態。
EV_ERR
0x0080
 行の状態エラーが発生しました。 行の状態エラーは 、CE_FRAME、 CE_OVERRUN、 およびCE_RXPARITYです。
EV_RING
0x0100
 リング インジケーターが検出されました。
EV_RLSD
0x0020
 RLSD (receive-line-signal-detect) 信号の変更状態。
EV_RXCHAR
0x0001
 文字が受信され、入力バッファーに格納されました。
EV_RXFLAG
0x0002
 イベント文字が受信され、入力バッファーに配置されました。 イベント文字は、SetCommState 関数を使用してシリアル ポートに適用される、デバイスの DCB 構造体で指定されます。
EV_TXEMPTY
0x0004
 出力バッファーの最後の文字が送信されました。

戻り値

関数が成功すると、戻り値は 0 以外になります。

関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

SetCommMask 関数は、特定の通信リソースに対して監視できるイベントのセットを指定します。 通信リソースへのハンドルは、いずれかのイベントが発生するまで待機する WaitCommEvent 関数の呼び出しで指定できます。 通信リソースの現在のイベント マスクを取得するには、 GetCommMask 関数を使用します。

例

例については、「 通信イベントの監視」を参照してください。

要件

要件 値
サポートされている最小のクライアント Windows XP [デスクトップ アプリ | UWP アプリ]
サポートされている最小のサーバー Windows Server 2003 [デスクトップ アプリのみ | UWP アプリ]
対象プラットフォーム Windows
ヘッダー winbase.h (Windows.h を含む)
Library Kernel32.lib
[DLL] Kernel32.dll

関連項目

通信関数

通信リソース

CreateFile

DCB

GetCommMask

SetCommState

WaitCommEvent