IO_CSQ_COMPLETE_CANCELED_IRP função de retorno de chamada (wdm.h)

Artigo
02/27/2024

A rotina CsqCompleteCanceledIrp é usada pelo sistema para sinalizar ao driver que ele pode concluir um IRP cancelado.

Sintaxe

IO_CSQ_COMPLETE_CANCELED_IRP IoCsqCompleteCanceledIrp;

void IoCsqCompleteCanceledIrp(
  [in] PIO_CSQ Csq,
  [in] PIRP Irp
)
{...}

Parâmetros

[in] Csq

Ponteiro para a estrutura de IO_CSQ para a fila IRP com segurança de cancelamento.

[in] Irp

Ponteiro para o IRP a ser cancelado.

Retornar valor

Nenhum

Comentários

O driver especifica a rotina CsqCompleteCanceledIrp para uma fila IRP segura de cancelamento quando inicializa a estrutura IO_CSQ da fila. O driver especifica a rotina como o parâmetro CsqCompleteCanceledIrp de IoCsqInitialize ou IoCsqInitializeEx quando inicializa IO_CSQ. Para obter mais informações, consulte Filas de IRP com segurança de cancelamento.

O sistema chama essa rotina para concluir um IRP cancelado que foi removido da fila do driver. Normalmente, os drivers simplesmente chamam IoCompleteRequest para o IRP com uma status de STATUS_CANCELLED.

Os drivers não são necessários para remover o IRP da fila antes de concluí-lo como cancelado: o sistema sempre chama a rotina CsqRemoveIrp da fila para remover o IRP da fila antes de chamar CsqCompleteCanceledIrp.

Exemplos

Para definir uma rotina de retorno de chamada CsqCompleteCanceledIrp , primeiro você deve fornecer uma declaração de função que identifique o tipo de rotina de retorno de chamada que você está definindo. O Windows fornece um conjunto de tipos de função de retorno de chamada para drivers. Declarar uma função usando os tipos de função de retorno de chamada ajuda a Análise de Código para Drivers, SDV ( Verificador de Driver Estático ) e outras ferramentas de verificação a encontrar erros e é um requisito para gravar drivers para o sistema operacional Windows.

Por exemplo, para definir uma rotina de retorno de chamada CsqCompleteCanceledIrp chamada MyCsqCompleteCanceledIrp, use o tipo IO_CSQ_COMPLETE_CANCELED_IRP conforme mostrado neste exemplo de código:

IO_CSQ_COMPLETE_CANCELED_IRP MyCsqCompleteCanceledIrp;

Em seguida, implemente sua rotina de retorno de chamada da seguinte maneira:

_Use_decl_annotations_
VOID 
 MyCsqCompleteCanceledIrp(
    _In_ PIO_CSQ  Csq,
    _In_ PIRP  Irp
    )
  {
      // Function body
  }

O tipo de função IO_CSQ_COMPLETE_CANCELED_IRP é definido no arquivo de cabeçalho Wdm.h. Para identificar erros com mais precisão ao executar as ferramentas de análise de código, adicione a _Use_decl_annotations_ anotação à sua definição de função. A _Use_decl_annotations_ anotação garante que as anotações aplicadas ao tipo de função IO_CSQ_COMPLETE_CANCELED_IRP no arquivo de cabeçalho sejam usadas. Para obter mais informações sobre os requisitos para declarações de função, consulte Declarando funções usando tipos de função de função para drivers WDM. Para obter informações sobre _Use_decl_annotations_, consulte Anotando o comportamento da função.