IO_CSQ_PEEK_NEXT_IRP función de devolución de llamada (wdm.h)

Artículo
02/27/2024

El sistema usa la rutina CsqPeekNextIrp para buscar el siguiente IRP coincidente en una cola irP implementada por el controlador y segura para cancelar.

Sintaxis

IO_CSQ_PEEK_NEXT_IRP IoCsqPeekNextIrp;

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

Parámetros

[in] Csq

Puntero a la estructura de IO_CSQ para la cola irP segura de cancelación.

[in, optional] Irp

Puntero a un IRP en la cola irP del controlador o NULL para especificar el principio de la cola.

[in, optional] PeekContext

Puntero a la información de contexto definida por el controlador. La rutina CsqPeekNextIrp devuelve el primer IRP que sigue a Irp y coincide con PeekContext.

Valor devuelto

CsqPeekNextIrp devuelve el primer IRP que sigue a Irp en la cola y coincide con PeekContext o NULL si no hay irP coincidente. Si Irp es NULL, CsqPeekNextIrp devuelve el primer IRP coincidente en la cola o NULL si no hay irP coincidente.

Comentarios

El controlador especifica la rutina CsqPeekNextIrp para una cola irP segura para cancelaciones cuando inicializa la estructura de IO_CSQ de la cola. El controlador especifica la rutina como el parámetro CsqPeekNextIrp de IoCsqInitialize o IoCsqInitializeEx cuando inicializa IO_CSQ. Para obtener más información, consulte Cancel-Safe IRP Queues (Colas irP seguras para cancelar).

El sistema usa CsqPeekNextIrp para recorrer en iteración los IRP en la cola irP del controlador. Por ejemplo, la rutina IoCsqRemoveNextIrp usa esta rutina para buscar el IRP que se va a quitar.

Ejemplos

Para definir una rutina de devolución de llamada de CsqPeekNextIrp , primero debe proporcionar una declaración de función que identifique el tipo de rutina de devolución de llamada que está definiendo. Windows proporciona un conjunto de tipos de función de devolución de llamada para controladores. Declarar una función mediante los tipos de función de devolución de llamada ayuda a Code Analysis for Drivers, Static Driver Verifier (SDV) y otras herramientas de comprobación encuentran errores y es un requisito para escribir controladores para el sistema operativo Windows.

Por ejemplo, para definir una rutina de devolución de llamada de CsqPeekNextIrp denominada MyCsqPeekNextIrp, use el tipo IO_CSQ_PEEK_NEXT_IRP como se muestra en este ejemplo de código:

IO_CSQ_PEEK_NEXT_IRP MyCsqPeekNextIrp;

A continuación, implemente la rutina de devolución de llamada de la siguiente manera:

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

El tipo de función IO_CSQ_PEEK_NEXT_IRP se define en el archivo de encabezado Wdm.h. Para identificar con más precisión los errores al ejecutar las herramientas de análisis de código, asegúrese de agregar la anotación a la _Use_decl_annotations_ definición de la función. La _Use_decl_annotations_ anotación garantiza que se usen las anotaciones que se aplican al tipo de función IO_CSQ_PEEK_NEXT_IRP en el archivo de encabezado. Para obtener más información sobre los requisitos de las declaraciones de función, vea Declarar funciones mediante tipos de roles de función para controladores WDM. Para obtener información sobre _Use_decl_annotations_, consulte Anotación del comportamiento de la función.