Fonction SetCommState (winbase.h)

Article
03/06/2024

Configure un appareil de communication en fonction des spécifications d’un bloc de contrôle d’appareil (structure DCB ). La fonction réinitialise tous les paramètres matériels et de contrôle, mais elle ne vide pas les files d’attente de sortie ou d’entrée.

Syntaxe

BOOL SetCommState(
  [in] HANDLE hFile,
  [in] LPDCB  lpDCB
);

Paramètres

[in] hFile

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

[in] lpDCB

Pointeur vers une structure DCB qui contient les informations de configuration du périphérique de communication spécifié.

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

La fonction SetCommState utilise une structure DCB pour spécifier la configuration souhaitée. La fonction GetCommState retourne la configuration actuelle.

Pour définir seulement quelques membres de la structure DCB , vous devez modifier une structure DCB qui a été remplie par un appel à GetCommState. Cela garantit que les autres membres de la structure DCB ont des valeurs appropriées.

La fonction SetCommState échoue si le membre XonChar de la structure DCB est égal au membre XoffChar .

Lorsque SetCommState est utilisé pour configurer le 8250, les restrictions suivantes s’appliquent aux valeurs des membres ByteSize et StopBits de la structure DCB :

Le nombre de bits de données doit être compris entre 5 et 8 bits.

Exemples

Pour obtenir un exemple, consultez Configuration d’une ressource de communication.

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