GetDefaultCommConfigA 関数 (winbase.h)

指定した通信デバイスの既定の構成を取得します。

構文

BOOL GetDefaultCommConfigA(
  [in]      LPCSTR       lpszName,
  [out]     LPCOMMCONFIG lpCC,
  [in, out] LPDWORD      lpdwSize
);

パラメーター

[in] lpszName

デバイスの名前。 たとえば、COM1 から COM9 はシリアル ポート、LPT1 から LPT9 は並列ポートです。

[out] lpCC

COMMCONFIG 構造体を受け取るバッファーへのポインター。

[in, out] lpdwSize

lpCC が指すバッファーのサイズをバイト単位で指定する変数へのポインター。 戻り時に、関数が成功した場合にコピーされたバイト数、またはバッファーが小さすぎる場合に必要なバイト数が変数に含まれます。

戻り値

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

関数が失敗した場合は、0 を返します。 拡張エラー情報を取得するには、 GetLastError 関数を使用します。

注釈

注意

winbase.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして GetDefaultCommConfig を定義します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

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

関連項目

COMMCONFIG

Communications 関数

通信リソース

SetDefaultCommConfig