Função SerCx2CustomReceiveTransactionCreate (sercx.h)

Artigo
08/07/2023

O método SerCx2CustomReceiveTransactionCreate cria um objeto custom-receive-transaction, que a versão 2 da extensão de estrutura serial (SerCx2) usa para executar transações de recebimento personalizado.

Sintaxe

NTSTATUS SerCx2CustomReceiveTransactionCreate(
  [in]  SERCX2CUSTOMRECEIVE                       CustomReceive,
  [in]  PSERCX2_CUSTOM_RECEIVE_TRANSACTION_CONFIG CustomReceiveTransactionConfig,
  [in]  PWDF_OBJECT_ATTRIBUTES                    Attributes,
  [out] SERCX2CUSTOMRECEIVETRANSACTION            *CustomReceiveTransaction
);

Parâmetros

[in] CustomReceive

Um identificador de SERCX2CUSTOMRECEIVE para um objeto de recebimento personalizado. O driver do controlador serial anteriormente chamou o método SerCx2CustomReceiveCreate para criar esse objeto.

[in] CustomReceiveTransactionConfig

Um ponteiro para uma estrutura SERCX2_CUSTOM_RECEIVE_TRANSACTION_CONFIG . Antes de chamar esse método, o chamador deve chamar a função SERCX2_CUSTOM_RECEIVE_TRANSACTION_CONFIG_INIT para inicializar a estrutura. Essa estrutura contém ponteiros para um conjunto de rotinas de retorno de chamada de evento implementadas pelo driver do controlador serial. O SerCx2 chama essas funções para fazer uma transação de E/S que usa o mecanismo de transferência de dados personalizado para ler os dados recebidos pelo controlador serial.

[in] Attributes

Um ponteiro para uma estrutura WDF_OBJECT_ATTRIBUTES que descreve os atributos a serem atribuídos ao novo objeto custom-receive-transaction. Antes de chamar esse método, o chamador deve chamar a função WDF_OBJECT_ATTRIBUTES_INIT para inicializar a estrutura. Esse parâmetro é opcional e pode ser especificado como WDF_NO_OBJECT_ATTRIBUTES se o driver do controlador serial não precisar atribuir atributos ao objeto . Para obter mais informações, consulte Comentários.

[out] CustomReceiveTransaction

Um ponteiro para um local no qual esse método grava um identificador de SERCX2CUSTOMRECEIVETRANSACTION no objeto custom-receive-transaction recém-criado. O SerCx2 e o driver do controlador serial usam esse identificador em chamadas subsequentes para fazer referência a esse objeto.

Retornar valor

Esse método retornará STATUS_SUCCESS se a chamada for bem-sucedida. Os valores de retorno de erro possíveis incluem os seguintes códigos de status.

Código de retorno	Descrição
STATUS_INVALID_DEVICE_REQUEST	Um objeto custom-receive-transaction já existe de uma chamada serCx2CustomReceiveTransactionCreate anterior.
STATUS_INFO_LENGTH_MISMATCH	O valor CustomReceiveTransactionConfig->Size não é igual a sizeof(SERCX2_CUSTOM_RECEIVE_TRANSACTION_CONFIG).
STATUS_INVALID_PARAMETER	Um valor de parâmetro não é válido. O chamador deve fornecer ponteiros válidos da função EvtSerCx2CustomReceiveTransactionStart e EvtSerCx2CustomReceiveTransactionQueryProgress .
STATUS_INSUFFICIENT_RESOURCES	Recursos insuficientes estão disponíveis para criar o objeto custom-receive-transaction.

Comentários

O driver do controlador serial pode chamar esse método para criar um objeto custom-receive-transaction. O SerCx2 usa esse objeto para gerenciar transações de recebimento personalizado, que são transações de E/S que usam um mecanismo de transferência de dados personalizado para ler os dados recebidos pelo controlador serial.

Como opção, um driver de controlador serial pode usar o parâmetro Attributes para criar um contexto para o objeto de recebimento personalizado e fornecer ponteiros para as funções EvtCleanupCallback e EvtDestroyCallback que são chamadas para preparar o objeto para exclusão. Para obter mais informações, consulte WDF_OBJECT_ATTRIBUTES.

Se o parâmetro Attributes apontar para uma estrutura WDF_OBJECT_ATTRIBUTES , o chamador não deverá substituir os valores que a função de inicialização WDF_OBJECT_ATTRIBUTES_INIT grava nos membros ParentObject, ExecutionLevel e SynchronizationScope dessa estrutura.

Se a combinação especificada de funções de retorno de chamada implementadas não for válida, a chamada SerCx2CustomReceiveTransactionCreate falhará e retornará STATUS_INVALID_PARAMETER.

Para obter mais informações sobre como criar objetos custom-receive-transaction, consulte SERCX2CUSTOMRECEIVETRANSACTION. Para obter mais informações sobre transações de recebimento personalizado, consulte SerCx2 Custom-Receive Transactions.