SerCx2PioReceiveCreate, fonction (sercx.h)

Article
10/30/2024

La méthode SerCx2PioReceiveCreate crée un objet de réception PIO, que la version 2 de l’extension d’infrastructure série (SerCx2) utilise pour effectuer des transactions de réception PIO.

Syntaxe

NTSTATUS SerCx2PioReceiveCreate(
  [in]           WDFDEVICE                  Device,
  [in]           PSERCX2_PIO_RECEIVE_CONFIG PioReceiveConfig,
  [in, optional] PWDF_OBJECT_ATTRIBUTES     Attributes,
  [out]          SERCX2PIORECEIVE           *PioReceive
);

Paramètres

[in] Device

Handle WDFDEVICE pour l’objet d’appareil framework qui représente le contrôleur série. Le pilote de contrôleur série a créé cet objet dans sa fonction de rappel EvtDriverDeviceAdd. Pour plus d’informations, consultez SerCx2InitializeDevice.

[in] PioReceiveConfig

Pointeur vers une structure SERCX2_PIO_RECEIVE_CONFIG. Avant d’appeler cette méthode, l’appelant doit appeler la fonction SERCX2_PIO_RECEIVE_CONFIG_INIT pour initialiser la structure. Cette structure contient des pointeurs vers un ensemble de routines de rappel d’événements implémentées par le pilote du contrôleur série. SerCx2 appelle ces fonctions pour effectuer des transactions de réception d’authentification unique.

[in, optional] Attributes

Pointeur vers une structure WDF_OBJECT_ATTRIBUTES qui décrit les attributs à affecter au nouvel objet piO-receive. Avant d’appeler cette méthode, l’appelant doit appeler la fonction WDF_OBJECT_ATTRIBUTES_INIT pour initialiser la structure. Ce paramètre est facultatif et peut être spécifié en tant que WDF_NO_OBJECT_ATTRIBUTES si le pilote du contrôleur série n’a pas besoin d’affecter des attributs à l’objet. Pour plus d’informations, consultez Remarques.

[out] PioReceive

Pointeur vers un emplacement dans lequel cette méthode écrit un handle SERCX2PIORECEIVE dans l’objet de réception PIO nouvellement créé. SerCx2 et le pilote de contrôleur série utilisent ce handle dans les appels suivants pour faire référence à cet objet.

Valeur de retour

Cette méthode retourne STATUS_SUCCESS si l’appel réussit. Les valeurs de retour d’erreur possibles incluent les codes d’état suivants.

Retourner le code	Description
STATUS_INVALID_DEVICE_REQUEST	Un objet PIO-receive existe déjà à partir d’un appel précédent SerCx2PioReceiveCreate.
STATUS_INFO_LENGTH_MISMATCH	La valeur taille deconfig ne correspond pas à (SERCX2_PIO_RECEIVE_CONFIG).
STATUS_INVALID_PARAMETER	La combinaison spécifiée de fonctions de rappel implémentées n’est pas valide. Le pilote doit implémenter les evtSerCx2PioReceiveReadBuffer, EvtSerCx2PioReceiveEnableReadyNotificationet EvtSerCx2PioReceiveCancelReadyNotification.
STATUS_INSUFFICIENT_RESOURCES	Les ressources insuffisantes sont disponibles pour effectuer l’opération demandée.

Remarques

Votre pilote de contrôleur série appelle cette méthode pour créer un objet piO-receive. SerCx2 utilise cet objet pour effectuer des transactions piO-receive, qui utilisent des E/S programmés (PIO) pour lire les données reçues par le contrôleur série.

En règle générale, un pilote de contrôleur série appelle SerCx2PioReceiveCreate à partir de sa fonction EvtDriverDeviceAdd. Le pilote doit appeler cette méthode uniquement après avoir appelé la méthode SerCx2InitializeDevice.

En guise d’option, un pilote de contrôleur série peut utiliser le paramètre Attributes pour créer un contexte pour l’objet piO-receive et fournir des pointeurs vers EvtCleanupCallback et EvtDestroyCallback fonctions appelées pour préparer l’objet à la suppression. Pour plus d’informations, consultez WDF_OBJECT_ATTRIBUTES.

Si le paramètre Attributes pointe vers une structure WDF_OBJECT_ATTRIBUTES, l’appelant ne doit pas remplacer les valeurs que la fonction d’initialisation WDF_OBJECT_ATTRIBUTES_INIT écrit dans le ParentObject, ExecutionLevelet SynchronizationScope membres de cette structure.

Pour plus d’informations sur la création d’objets piO-receive, consultez SERCX2PIORECEIVE. Pour plus d’informations sur les transactions de réception d’authentification personnelle, consultez SerCx2 PIO-Receive Transactions.