GetCommProperties 関数 (winbase.h)

指定した通信デバイスの通信プロパティに関する情報を取得します。

構文

BOOL GetCommProperties(
  [in]  HANDLE     hFile,
  [out] LPCOMMPROP lpCommProp
);

[in] hFile

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

[out] lpCommProp

通信プロパティ情報が返される COMMPROP 構造体へのポインター。この情報は、 SetCommState、 SetCommTimeouts、または SetupComm 関数の後続の呼び出しで使用して、通信デバイスを構成できます。

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

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

GetCommProperties 関数は、ドライバーでサポートされている構成設定に関する情報をデバイスドライバーから返します。

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