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

Artigo
02/27/2024

A rotina CsqPeekNextIrp é usada pelo sistema para localizar o próximo IRP correspondente em uma fila IRP com segurança de cancelamento implementada pelo driver.

Sintaxe

IO_CSQ_PEEK_NEXT_IRP IoCsqPeekNextIrp;

PIRP IoCsqPeekNextIrp(
  [in]           PIO_CSQ Csq,
  [in, optional] PIRP Irp,
  [in, optional] PVOID PeekContext
)
{...}

Parâmetros

[in] Csq

Ponteiro para a estrutura de IO_CSQ para a fila IRP cancel-safe.

[in, optional] Irp

Ponteiro para um IRP na fila IRP do driver ou NULL para especificar o início da fila.

[in, optional] PeekContext

Ponteiro para informações de contexto definidas pelo driver. A rotina CsqPeekNextIrp retorna o primeiro IRP que segue Irp e corresponde a PeekContext.

Retornar valor

CsqPeekNextIrp retorna o primeiro IRP que segue Irp na fila e corresponde a PeekContext ou NULL se não houver NENHUM IRP correspondente. Se Irp for NULL, CsqPeekNextIrp retornará o primeiro IRP correspondente na fila ou NULL se não houver NENHUM IRP correspondente.

Comentários

O driver especifica a rotina CsqPeekNextIrp para uma fila IRP cancel-safe quando inicializa a estrutura de IO_CSQ da fila. O driver especifica a rotina como o parâmetro CsqPeekNextIrp de IoCsqInitialize ou IoCsqInitializeEx quando inicializa IO_CSQ. Para obter mais informações, consulte Filas IRP cancel-safe.

O sistema usa CsqPeekNextIrp para iterar pelos IRPs na fila IRP do driver. Por exemplo, a rotina IoCsqRemoveNextIrp usa essa rotina para localizar o IRP a ser removido.

Exemplos

Para definir uma rotina de retorno de chamada CsqPeekNextIrp , 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 escrever drivers para o sistema operacional Windows.

Por exemplo, para definir uma rotina de retorno de chamada CsqPeekNextIrp chamada MyCsqPeekNextIrp, use o tipo IO_CSQ_PEEK_NEXT_IRP conforme mostrado neste exemplo de código:

IO_CSQ_PEEK_NEXT_IRP MyCsqPeekNextIrp;

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

_Use_decl_annotations_
PIRP 
 MyCsqPeekNextIrp(
    PIO_CSQ  Csq,
    PIRP  Irp,
    PVOID  PeekContext
    )
  {
      // Function body
  }

O tipo de função IO_CSQ_PEEK_NEXT_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_PEEK_NEXT_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.