SetupComm-Funktion (winbase.h)

Initialisiert die Kommunikationsparameter für ein angegebenes Kommunikationsgerät.

Syntax

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

Parameter

[in] hFile

Ein Handle für das Kommunikationsgerät. Die CreateFile-Funktion gibt dieses Handle zurück.

[in] dwInQueue

Die empfohlene Größe des internen Eingabepuffers des Geräts in Bytes.

[in] dwOutQueue

Die empfohlene Größe des internen Ausgabepuffers des Geräts in Bytes.

Rückgabewert

Wenn die Funktion erfolgreich ist, ist der Rückgabewert ungleich Null.

Wenn die Funktion fehlerhaft ist, ist der Rückgabewert null. Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf.

Hinweise

Nachdem ein Prozess die CreateFile-Funktion verwendet hat, um ein Handle für ein Kommunikationsgerät zu öffnen, aber bevor er E/A mit dem Gerät ausführt, kann er SetupComm aufrufen, um die Kommunikationsparameter für das Gerät festzulegen. Wenn sie nicht festgelegt werden, verwendet das Gerät die Standardparameter, wenn der erste Aufruf einer anderen Kommunikationsfunktion erfolgt.

Die Parameter dwInQueue und dwOutQueue geben die empfohlenen Größen für die internen Puffer an, die vom Treiber für das angegebene Gerät verwendet werden. Beispielsweise sind YMODEM-Protokollpakete etwas größer als 1024 Bytes. Daher kann eine empfohlene Puffergröße 1200 Bytes für die YMODEM-Kommunikation betragen. Für die Ethernet-basierte Kommunikation kann eine empfohlene Puffergröße 1600 Bytes sein, was etwas größer als ein einzelner Ethernet-Frame ist.

Der Gerätetreiber empfängt die empfohlenen Puffergrößen, kann jedoch jedes Eingabe- und Ausgabepufferungsschema (E/A) verwenden, solange er eine angemessene Leistung bietet und daten aufgrund von Überlauf nicht verloren gehen (außer unter extremen Umständen). Beispielsweise kann die Funktion erfolgreich sein, auch wenn der Treiber keinen Puffer zuordnet, solange ein anderer Teil des Systems entsprechende Funktionen bereitstellt.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows XP [Desktop-Apps | UWP-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2003 [Desktop-Apps | UWP-Apps]
Zielplattform	Windows
Kopfzeile	winbase.h (Windows.h einschließen)
Bibliothek	Kernel32.lib
DLL	Kernel32.dll

Siehe auch

Kommunikationsfunktionen

Kommunikationsressourcen

CreateFile

SetCommState