SerCx2CustomTransmitTransactionCreate, fonction (sercx.h)

Article
08/07/2023

La méthode SerCx2CustomTransmitTransactionCreate crée un objet de transaction de transmission personnalisée, que la version 2 de l’extension d’infrastructure série (SerCx2) utilise pour effectuer des transactions de transmission personnalisées.

Syntaxe

NTSTATUS SerCx2CustomTransmitTransactionCreate(
  [in]  SERCX2CUSTOMTRANSMIT                       CustomTransmit,
  [in]  PSERCX2_CUSTOM_TRANSMIT_TRANSACTION_CONFIG CustomTransmitTransactionConfig,
  [in]  PWDF_OBJECT_ATTRIBUTES                     Attributes,
  [out] SERCX2CUSTOMTRANSMITTRANSACTION            *CustomTransmitTransaction
);

Paramètres

[in] CustomTransmit

Un handle SERCX2CUSTOMTRANSMIT à un objet de transmission personnalisée. Le pilote de contrôleur série a précédemment appelé la méthode SerCx2CustomTransmitCreate pour créer cet objet.

[in] CustomTransmitTransactionConfig

Pointeur vers une structure SERCX2_CUSTOM_TRANSMIT_TRANSACTION_CONFIG . Avant d’appeler cette méthode, l’appelant doit appeler la fonction SERCX2_CUSTOM_TRANSMIT_TRANSACTION_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 de contrôleur série. SerCx2 appelle ces fonctions pour effectuer une transaction d’E/S qui utilise le mécanisme de transfert de données personnalisé pour écrire des données dans le contrôleur série à transmettre.

[in] Attributes

Pointeur vers une structure de WDF_OBJECT_ATTRIBUTES qui décrit les attributs à affecter au nouvel objet de transaction de transmission personnalisée. 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é comme WDF_NO_OBJECT_ATTRIBUTES si le pilote de contrôleur série n’a pas besoin d’affecter des attributs à l’objet. Pour plus d'informations, consultez la section Notes.

[out] CustomTransmitTransaction

Pointeur vers un emplacement dans lequel cette méthode écrit un SERCX2CUSTOMTRANSMITTRANSACTION handle vers l’objet de transaction custom-transmit-transaction 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 retournée

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

Code de retour	Description
STATUS_INVALID_DEVICE_REQUEST	Un objet de transaction de transmission personnalisée existe déjà à partir d’un appel précédent de SerCx2CustomTransmitTransactionCreate .
STATUS_INFO_LENGTH_MISMATCH	La valeur CustomTransmitTransactionConfig->Size n’est pas égale à sizeof(SERCX2_CUSTOM_TRANSMIT_TRANSACTION_CONFIG).
STATUS_INVALID_PARAMETER	Une valeur de paramètre n’est pas valide. L’appelant doit fournir un pointeur de fonction EvtSerCx2CustomTransmitTransactionStart valide.
STATUS_INSUFFICIENT_RESOURCES	Les ressources disponibles sont insuffisantes pour créer l’objet transactionnel de transmission personnalisée.

Remarques

Votre pilote de contrôleur série peut appeler cette méthode pour créer un objet de transaction de transmission personnalisée. SerCx2 utilise cet objet pour gérer les transactions de transmission personnalisées, qui sont des transactions d’E/S qui utilisent un mécanisme de transfert de données personnalisé pour écrire des données dans le contrôleur série à transmettre.

En option, un pilote de contrôleur série peut utiliser le paramètre Attributes pour créer un contexte pour l’objet de transmission personnalisée et pour fournir des pointeurs vers les fonctions EvtCleanupCallback et EvtDestroyCallback appelées pour préparer l’objet en vue de 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 sur les membres ParentObject, ExecutionLevel et SynchronizationScope de cette structure.

Si la combinaison spécifiée de fonctions de rappel implémentées n’est pas valide, SerCx2CustomTransmitTransactionCreate échoue et retourne STATUS_INVALID_PARAMETER.

Pour plus d’informations sur la création d’objets de transaction de transmission personnalisée, consultez SERCX2CUSTOMTRANSMITTRANSACTION. Pour plus d’informations sur les transactions de transmission personnalisée, consultez Transactions SerCx2 Custom-Transmit.