Partager via

SerCxProgressReceive, fonction (sercx.h)

  • Article

La méthode SerCxProgressReceive signale la progression de l’opération de lecture (réception) actuelle.

Syntaxe

NTSTATUS SerCxProgressReceive(
  [in] WDFDEVICE    Device,
  [in] ULONG        BytesReceived,
  [in] SERCX_STATUS ReceiveStatus
);

Paramètres

[in] Device

Handle WDFDEVICE pour l’objet d’appareil framework qui représente le contrôleur série.

[in] BytesReceived

Nombre d’octets de données que l’appelant a chargé dans la mémoire tampon de réception obtenue par le dernier appel à la méthode SerCxRetrieveReceiveBuffer.

[in] ReceiveStatus

État actuel de l’opération de réception. Définissez ce paramètre sur l’une des valeurs suivantes :

  • SerCxStatusSuccess
  • SerCxStatusCancelled
  • SerCxStatusTimeout
Pour plus d’informations sur ces valeurs, consultez SERCX_STATUS.

Valeur de retour

SerCxProgressReceive retourne STATUS_SUCCESS si elle réussit. Les valeurs de retour d’erreur possibles incluent les codes d’état suivants.

Retourner le code Description
STATUS_INVALID_PARAMETER
 La valeur BytesReceived dépasse la longueur de la mémoire tampon disponible ; ou la valeur ReceiveStatus n’est pas valide.
STATUS_INVALID_DEVICE_REQUEST
 La méthode a été appelée au mauvais IRQL ; ou le handle WDFDEVICE n’est pas valide ; ou le pilote n’a pas obtenu de mémoire tampon d’entrée pour cette opération de réception.
STATUS_CANCELLED
 L’opération de réception a déjà été annulée.

Remarques

Le pilote de contrôleur série appelle cette méthode pour signaler la progression d’une opération de lecture en attente. En règle générale, le pilote du contrôleur série appelle cette méthode à partir de son rappel de saisie semi-automatique DMA (si le pilote utilise DMA pour lire les données) ou à partir de sa fonction DPC de transmission/réception (si l’authentification personnelle est utilisée).

Si le SerCxProgressReceive n’effectue pas toutes les tâches en suspens pour l’opération de lecture, l’appelant doit appeler à nouveau la méthode SerCxRetrieveReceiveBuffer pour obtenir un nouveau descripteur de mémoire tampon et continuer à recevoir des données.

Exigences

Exigence Valeur
client minimum pris en charge Disponible à partir de Windows 8.
plateforme cible Universel
d’en-tête sercx.h
IRQL <= DISPATCH_LEVEL

Voir aussi

SERCX_STATUS

SerCxRetrieveReceiveBuffer