SetupComm 関数 (winbase.h)

指定した通信デバイスの通信パラメーターを初期化します。

構文

BOOL SetupComm(
  [in] HANDLE hFile,
  [in] DWORD  dwInQueue,
  [in] DWORD  dwOutQueue
);

パラメーター

[in] hFile

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

[in] dwInQueue

デバイスの内部入力バッファーの推奨サイズ (バイト単位)。

[in] dwOutQueue

デバイスの内部出力バッファーの推奨サイズ (バイト単位)。

戻り値

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

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

解説

プロセスで CreateFile 関数を使用して通信デバイスへのハンドルを開いた後、デバイスで I/O を実行する前に SetupComm を呼び出して、デバイスの通信パラメーターを設定できます。 設定されていない場合、デバイスは別の通信関数への最初の呼び出しが発生したときに既定のパラメーターを使用します。

dwInQueue パラメーターと dwOutQueue パラメーターは、指定されたデバイスのドライバーによって使用される内部バッファーに推奨されるサイズを指定します。 たとえば、YMODEM プロトコル パケットは 1024 バイトより少し大きくなります。 したがって、YMODEM 通信の場合、推奨されるバッファー サイズは 1200 バイトである可能性があります。 イーサネット ベースの通信の場合、推奨されるバッファー サイズは 1600 バイトで、1 つのイーサネット フレームよりもわずかに大きい場合があります。

デバイス ドライバーは推奨されるバッファー サイズを受け取りますが、適切なパフォーマンスを提供し、オーバーランによってデータが失われない限り (極端な状況を除く)、任意の入出力 (I/O) バッファリング スキームを自由に使用できます。 たとえば、システムの他の部分が同等の機能を提供している限り、ドライバーがバッファーを割り当てない場合でも、関数は成功します。

要件

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

関連項目

Communications 関数

通信リソース

CreateFile

SetCommState