SERIAL_STATUS structure (ntddser.h)

La structure SERIAL_STATUS contient status informations sur le port série.

Syntaxe

typedef struct _SERIAL_STATUS {
  ULONG   Errors;
  ULONG   HoldReasons;
  ULONG   AmountInInQueue;
  ULONG   AmountInOutQueue;
  BOOLEAN EofReceived;
  BOOLEAN WaitForImmediate;
} SERIAL_STATUS, *PSERIAL_STATUS;

Membres

Errors

Ensemble d’indicateurs pour indiquer les erreurs de réception qui se sont produites dans le flux d’entrée. Ce membre est défini sur zéro ou sur le bit-OR d’un ou plusieurs des bits d’indicateur suivants.

Nom de l’indicateur	Signification
SERIAL_ERROR_QUEUEOVERRUN	La mémoire tampon d’entrée interne du pilote du contrôleur série a été dépassée par les données reçues du flux d’entrée. Soit la mémoire tampon d’entrée est pleine, soit un caractère a été reçu après le caractère EOF (fin du fichier).
SERIAL_ERROR_OVERRUN	La réception du matériel FIFO a été dépassée par les données reçues du flux d’entrée.
SERIAL_ERROR_BREAK	Une condition d’arrêt s’est produite sur la ligne d’entrée.
SERIAL_ERROR_PARITY	Une erreur de parité a été détectée dans un octet reçu du flux d’entrée.
SERIAL_ERROR_FRAMING	Une erreur d’encadrement a été détectée dans les octets reçus du flux d’entrée.

 

Une fois que le pilote du contrôleur série a spécifié les indicateurs SERIAL_ERROR_XXX accumulés pour répondre à une demande de IOCTL_SERIAL_GET_COMMSTATUS , le pilote réinitialise les indicateurs à zéro.

HoldReasons

Ensemble d’indicateurs pour indiquer les raisons pour lesquelles le port série attend actuellement la transmission d’octets au flux de sortie. Ce membre est défini sur zéro ou sur le bit-OR d’un ou plusieurs des bits d’indicateur suivants.

Nom de l’indicateur	Signification
SERIAL_TX_WAITING_FOR_CTS	En attente du signal CTS (clear to send).
SERIAL_TX_WAITING_FOR_DSR	En attente du signal DSR (jeu de données prêt).
SERIAL_TX_WAITING_FOR_DCD	En attente du signal DCD (détection du support de données).
SERIAL_TX_WAITING_FOR_XON	En attente du signal XON (transmettre sur).
SERIAL_TX_WAITING_ON_BREAK	Envoi d’un signal d’arrêt (valeur d’espacement).
SERIAL_TX_WAITING_XOFF_SENT	Envoi d’un signal XOFF (transmission désactivée). Ce signal marque la fin de la transmission à partir du port série, qui attend ensuite que l’appareil à l’autre extrémité de la ligne commence à transmettre. L’autre appareil reçoit le signal XOFF transmis en tant que signal XON.

 

HoldReasons est égal à zéro si le port série n’a aucune raison d’arrêter la transmission des octets.

AmountInInQueue

Nombre d’octets de données reçus du port série actuellement disponibles pour la lecture à partir de la mémoire tampon d’entrée.

AmountInOutQueue

Nombre d’octets de données de transmission en attente d’écriture à partir de la mémoire tampon de sortie vers le port série.

EofReceived

Si un caractère EOF (fin du fichier) a été reçu. Ce membre a la valeur TRUE si un EOF a été reçu. Sinon, elle est FALSE. Le caractère EOF marque la fin du flux d’entrée.

WaitForImmediate

Indique si le port série attend pour transmettre un caractère immédiat. Ce membre a la valeur TRUE si le port série attend la transmission d’un caractère immédiat. Sinon, elle est FALSE. La transmission d’un caractère immédiat peut être retardée si un bit d’indicateur autre que SERIAL_TX_WAITING_FOR_XON est défini dans le membre HoldReasons . Pour plus d’informations sur les caractères immédiats, consultez IOCTL_SERIAL_IMMEDIATE_CHAR.

Remarques

Cette structure est utilisée par la requête IOCTL_SERIAL_GET_COMMSTATUS .

Configuration requise

Condition requise	Valeur
En-tête	ntddser.h

Voir aussi

IOCTL_SERIAL_GET_COMMSTATUS

IOCTL_SERIAL_IMMEDIATE_CHAR