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

Artículo
02/27/2024

El sistema usa la rutina CsqCompleteCanceledIrp para indicar al controlador que puede completar un IRP cancelado.

Sintaxis

IO_CSQ_COMPLETE_CANCELED_IRP IoCsqCompleteCanceledIrp;

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

Parámetros

[in] Csq

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

[in] Irp

Puntero al IRP que se va a cancelar.

Valor devuelto

None

Observaciones

El controlador especifica la rutina CsqCompleteCanceledIrp para una cola IRP segura para cancelación cuando inicializa la estructura de IO_CSQ de la cola. El controlador especifica la rutina como el parámetro CsqCompleteCanceledIrp 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 llama a esta rutina para completar un IRP cancelado que se ha quitado de la cola del controlador. Normalmente, los controladores simplemente llaman a IoCompleteRequest para irP con un estado de STATUS_CANCELLED.

Los controladores no son necesarios para quitar el IRP de la cola antes de completarlo como cancelado: el sistema siempre llama a la rutina CsqRemoveIrp de la cola para quitar el IRP de la cola antes de llamar a CsqCompleteCanceledIrp.

Ejemplos

Para definir una rutina de devolución de llamada de CsqCompleteCanceledIrp , 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 Análisis de código para controladores, Comprobador de controladores estáticos (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 CsqCompleteCanceledIrp denominada MyCsqCompleteCanceledIrp, use el tipo de IO_CSQ_COMPLETE_CANCELED_IRP como se muestra en este ejemplo de código:

IO_CSQ_COMPLETE_CANCELED_IRP MyCsqCompleteCanceledIrp;

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

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

El tipo de función IO_CSQ_COMPLETE_CANCELED_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_COMPLETE_CANCELED_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 rol de función para controladores WDM. Para obtener información sobre _Use_decl_annotations_, vea Anotación del comportamiento de la función.