Fonction SetupComm (winbase.h)

Initialise les paramètres de communication d’un appareil de communication spécifié.

Syntaxe

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

Paramètres

[in] hFile

Handle de l’appareil de communication. La fonction CreateFile retourne ce handle.

[in] dwInQueue

Taille recommandée de la mémoire tampon d’entrée interne de l’appareil, en octets.

[in] dwOutQueue

Taille recommandée de la mémoire tampon de sortie interne de l’appareil, en octets.

Valeur retournée

Si la fonction réussit, la valeur de retour est différente de zéro.

Si la fonction échoue, la valeur de retour est égale à zéro. Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError.

Remarques

Une fois qu’un processus utilise la fonction CreateFile pour ouvrir un handle sur un appareil de communication, mais avant d’effectuer des E/S avec l’appareil, il peut appeler SetupComm pour définir les paramètres de communication de l’appareil. S’il ne les définit pas, l’appareil utilise les paramètres par défaut lors du premier appel à une autre fonction de communication.

Les paramètres dwInQueue et dwOutQueue spécifient les tailles recommandées pour les mémoires tampons internes utilisées par le pilote pour l’appareil spécifié. Par exemple, les paquets de protocole YMODEM sont légèrement supérieurs à 1 024 octets. Par conséquent, une taille de mémoire tampon recommandée peut être de 1200 octets pour les communications YMODEM. Pour les communications basées sur Ethernet, une taille de mémoire tampon recommandée peut être de 1600 octets, ce qui est légèrement plus grand qu’une seule trame Ethernet.

Le pilote de périphérique reçoit les tailles de mémoire tampon recommandées, mais il est libre d’utiliser n’importe quel schéma de mise en mémoire tampon d’entrée et de sortie (E/S), tant qu’il fournit des performances raisonnables et que les données ne sont pas perdues en raison d’un dépassement (sauf dans des circonstances extrêmes). Par exemple, la fonction peut réussir même si le pilote n’alloue pas de mémoire tampon, tant qu’une autre partie du système fournit des fonctionnalités équivalentes.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows XP [applications de bureau | applications UWP]
Serveur minimal pris en charge	Windows Server 2003 [applications de bureau | applications UWP]
Plateforme cible	Windows
En-tête	winbase.h (inclure Windows.h)
Bibliothèque	Kernel32.lib
DLL	Kernel32.dll

Voir aussi

Fonctions de communication

Ressources de communication

CreateFile

SetCommState