Share via


SetCommState 関数 (winbase.h)

デバイス制御ブロック ( DCB 構造体) の仕様に従って通信デバイスを構成します。 関数は、すべてのハードウェアと制御の設定を再初期化しますが、出力キューや入力キューは空にしません。

構文

BOOL SetCommState(
  [in] HANDLE hFile,
  [in] LPDCB  lpDCB
);

パラメーター

[in] hFile

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

[in] lpDCB

指定した通信デバイスの構成情報を含む DCB 構造体へのポインター。

戻り値

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

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

解説

SetCommState 関数は、DCB 構造体を使用して目的の構成を指定します。 GetCommState 関数は、現在の構成を返します。

DCB 構造体の少数のメンバーのみを設定するには、GetCommState の呼び出しによって入力された DCB 構造体を変更する必要があります。 これにより、 DCB 構造体の他のメンバーが適切な値を持つことが保証されます。

DCB 構造体の XonChar メンバーが XoffChar メンバーと等しい場合、SetCommState 関数は失敗します。

SetCommState を使用して 8250 を構成する場合、DCB 構造体の ByteSize メンバーと StopBits メンバーの値には、次の制限が適用されます。

データ ビットの数は、5 ~ 8 ビットである必要があります。

例については、「 通信リソースの構成」を参照してください。

要件

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

関連項目

BuildCommDCB

Communications 関数

通信リソース

CreateFile

DCB

GetCommState