GetCommMask 関数 (winbase.h)
指定した通信デバイスのイベント マスクの値を取得します。
構文
BOOL GetCommMask(
[in] HANDLE hFile,
[out] LPDWORD lpEvtMask
);
パラメーター
[in] hFile
通信デバイスへのハンドル。 CreateFile 関数は、このハンドルを返します。
[out] lpEvtMask
現在有効になっているイベントのマスクを受け取る変数へのポインター。 このパラメーターには、次の 1 つ以上の値を指定できます。
値 | 意味 |
---|---|
|
入力時にブレークが検出されました。 |
|
CTS (送信クリア) シグナルの状態が変更されました。 |
|
DSR (データ セット対応) シグナルの状態が変更されました。 |
|
行状態エラーが発生しました。 行の状態エラーは 、CE_FRAME、 CE_OVERRUN、 およびCE_RXPARITY。 |
|
最初のプロバイダー固有の型のイベントが発生しました。 |
|
2 番目のプロバイダー固有の型のイベントが発生しました。 |
|
プリンター エラーが発生しました。 |
|
リング インジケーターが検出されました。 |
|
RLSD (receive-line-signal-detect) シグナル変更状態。 |
|
受信バッファーは 80% 満杯です。 |
|
文字が受信され、入力バッファーに格納されました。 |
|
イベント文字が受信され、入力バッファーに配置されました。 イベント文字は、SetCommState 関数を使用してシリアル ポートに適用される、デバイスの DCB 構造体で指定されます。 |
|
出力バッファーの最後の文字が送信されました。 |
戻り値
関数が成功すると、戻り値は 0 以外になります。
関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。
解説
GetCommMask 関数は、マスク変数を使用して、特定の通信リソースに対して監視できるイベントのセットを示します。 通信リソースへのハンドルは、いずれかのイベントが発生するのを待機する WaitCommEvent 関数の呼び出しで指定できます。 通信リソースのイベント マスクを変更するには、 SetCommMask 関数を使用します。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows XP [デスクトップ アプリ | UWP アプリ] |
サポートされている最小のサーバー | Windows Server 2003 [デスクトップ アプリのみ | UWP アプリ] |
対象プラットフォーム | Windows |
ヘッダー | winbase.h (Windows.h を含む) |
Library | Kernel32.lib |
[DLL] | Kernel32.dll |