GetCommModemStatus 関数 (winbase.h)
モデムコントロールレジスタ値を取得します。
構文
BOOL GetCommModemStatus(
[in] HANDLE hFile,
[out] LPDWORD lpModemStat
);
パラメーター
[in] hFile
通信デバイスへのハンドル。 CreateFile 関数は、このハンドルを返します。
[out] lpModemStat
モデム制御レジスタ値の現在の状態を受け取る変数へのポインター。 このパラメーターには、次の 1 つ以上の値を指定できます。
| 値 | 意味 |
|---|---|
|
CTS (送信クリア) 信号がオンです。 |
|
DSR (データ セット対応) 信号がオンです。 |
|
リングインジケーター信号がオンになっています。 |
|
RLSD (receive-line-signal-detect) 信号がオンです。 |
戻り値
関数が成功すると、戻り値は 0 以外になります。
関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。
解説
GetCommModemStatus 関数は、WaitCommEvent 関数を使用して CTS、RLSD、DSR、またはリング インジケーター信号を監視する場合に便利です。 これらのシグナルの状態がいつ変化するかを検出するには、 WaitCommEvent を使用し、 GetCommModemStatus を 使用して、変更が発生した後の状態を判断します。
ハードウェアがコントロール レジスタ値をサポートしていない場合、関数は失敗します。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows XP [デスクトップ アプリ | UWP アプリ] |
| サポートされている最小のサーバー | Windows Server 2003 [デスクトップ アプリのみ | UWP アプリ] |
| 対象プラットフォーム | Windows |
| ヘッダー | winbase.h (Windows.h を含む) |
| Library | Kernel32.lib |
| [DLL] | Kernel32.dll |