Função SerCxRetrieveReceiveBuffer (sercx.h)

Artigo
12/15/2024

O método SerCxRetrieveReceiveBuffer obtém um buffer de entrada no qual os dados recebidos da porta serial podem ser carregados.

Sintaxe

NTSTATUS SerCxRetrieveReceiveBuffer(
  [in]      WDFDEVICE                Device,
  [in]      ULONG                    Length,
  [in, out] PSERCX_BUFFER_DESCRIPTOR BufferDescriptor
);

Parâmetros

[in] Device

Um identificador WDFDEVICE para o objeto de dispositivo da estrutura que representa o controlador serial.

[in] Length

O comprimento do buffer solicitado, em bytes. Se a chamada SerCxRetrieveReceiveBuffer for bem-sucedida, o chamador receberá um buffer de entrada que contém até comprimento bytes de espaço disponível. (O espaço disponível no buffer pode ser menor que Comprimento bytes.) SerCxRetrieveReceiveBuffer grava o número real de bytes de espaço disponível no membro comprimento da estrutura apontado pelo parâmetro bufferDescriptor .

[in, out] BufferDescriptor

Um ponteiro para uma estrutura de SERCX_BUFFER_DESCRIPTOR alocada pelo chamador. Essa estrutura descreve o buffer de dados a ser usado para a operação de recebimento. O chamador chamou anteriormente a função SERCX_BUFFER_DESCRIPTOR_INIT para inicializar essa estrutura. serCxRetrieveTransmitBuffer grava nos membros buffer e length membros dessa estrutura.

Valor de retorno

SerCxRetrieveReceiveBuffer retornará STATUS_SUCCESS se for bem-sucedido. 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	O método foi chamado no IRQL errado; ou o identificador WDFDEVICE não é válido; ou dispositivo ou BufferDescriptor é NULL; ou o driver já tem um buffer de recebimento.
STATUS_INFO_LENGTH_MISMATCH	O tamanho incorreto é especificado para a estrutura de SERCX_BUFFER_DESCRIPTOR.
STATUS_INSUFFICIENT_RESOURCES	Não foi possível alocar recursos do sistema (normalmente memória).

Observações

O driver do controlador serial chama esse método para adquirir um buffer para conter dados de entrada da operação de recebimento (leitura) atual.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Disponível a partir do Windows 8.
da Plataforma de Destino	Universal
cabeçalho	sercx.h
IRQL	<= DISPATCH_LEVEL

Consulte também

SERCX_BUFFER_DESCRIPTOR

SERCX_BUFFER_DESCRIPTOR_INIT

Compartilhar via