Función ZwDeviceIoControlFile (ntifs.h)

Artículo
12/22/2024

La rutina ZwDeviceIoControlFile envía un código de control directamente a un controlador de dispositivo especificado, lo que hace que el controlador correspondiente realice la operación especificada.

Sintaxis

NTSYSAPI NTSTATUS ZwDeviceIoControlFile(
  [in]            HANDLE           FileHandle,
  [in, optional]  HANDLE           Event,
  [in, optional]  PIO_APC_ROUTINE  ApcRoutine,
  [in, optional]  PVOID            ApcContext,
  [out]           PIO_STATUS_BLOCK IoStatusBlock,
  [in]            ULONG            IoControlCode,
  [in, optional]  PVOID            InputBuffer,
  [in]            ULONG            InputBufferLength,
  [out, optional] PVOID            OutputBuffer,
  [in]            ULONG            OutputBufferLength
);

Parámetros

[in] FileHandle

Identificador devuelto por ZwCreateFile o ZwOpenFile para el objeto de archivo que representa el dispositivo al que se debe proporcionar o desde qué información de control se debe devolver. El objeto de archivo debe haberse abierto para E/S asincrónica si el autor de la llamada especifica un Event, ApcRoutiney un contexto de APC (en ApcContext) o un contexto de finalización (en ApcContext). Para la E/S a un dispositivo de almacenamiento masivo subyacente, el objeto de archivo debe haberse abierto para el acceso directo al dispositivo de almacenamiento (DASD).

[in, optional] Event

Identificador de un evento creado por el autor de la llamada. Si se proporciona este parámetro, el autor de la llamada se colocará en un estado de espera hasta que se complete la operación solicitada y el evento especificado se establezca en el estado Signaled. Este parámetro es opcional y se puede NULL. Debe ser NULL si el autor de la llamada esperará a que el FileHandle se establezca en el estado Signaled.

[in, optional] ApcRoutine

Dirección de una rutina de APC opcional proporcionada por el autor de la llamada que se va a llamar cuando se completa la operación solicitada. Este parámetro puede ser null. Debe ser NULL si hay un objeto de finalización de E/S asociado al objeto de archivo.

[in, optional] ApcContext

Puntero a un área de contexto determinada por el autor de la llamada. Este valor de parámetro se usa como contexto de APC si el autor de la llamada proporciona un APC o se usa como contexto de finalización si se ha asociado un objeto de finalización de E/S al objeto de archivo. Cuando se completa la operación, el contexto de APC se pasa al APC, si se especificó uno o el contexto de finalización se incluye como parte del mensaje de finalización que el Administrador de E/S envía al objeto de finalización de E/S asociado.

Este parámetro es opcional y se puede NULL. Debe ser NULL si ApcRoutine es NULL y no hay ningún objeto de finalización de E/S asociado al objeto de archivo.

[out] IoStatusBlock

Puntero a una variable que recibe el estado de finalización final e información sobre la operación. Para llamadas correctas que devuelven datos, se devuelve el número de bytes escritos en el outputBuffer en el miembro Information de .

[in] IoControlCode

IOCTL_código XXX que indica en qué operación de control de E/S del dispositivo se va a realizar, normalmente por el controlador de dispositivo subyacente. El valor de este parámetro determina el formato y la longitud necesaria del InputBuffer y OutputBuffer, así como cuál de los siguientes pares de parámetros son necesarios. Para obtener información detallada sobre los códigos de IOCTL_XXX de definidos por el sistema, consulte la sección específica de la tecnología de dispositivos de la documentación del Kit de controladores de Microsoft Windows (WDK) y códigos de control de entrada y salida del dispositivo en la documentación de Microsoft Windows SDK.

[in, optional] InputBuffer

Puntero a un búfer de entrada asignado por el autor de la llamada que contiene información específica del dispositivo que se va a proporcionar al dispositivo de destino. Si ioControlCode especifica una operación que no requiere datos de entrada, este puntero puede ser NULL.

[in] InputBufferLength

Tamaño, en bytes, del búfer en InputBuffer. Si InputBuffer es NULL , establezca InputBufferLength en cero.

[out, optional] OutputBuffer

Puntero a un búfer de salida asignado por el autor de la llamada en el que se devuelve información del dispositivo de destino. Si ioControlCode especifica una operación que no genera datos de salida, este puntero puede ser NULL.

[in] OutputBufferLength

Tamaño, en bytes, del búfer en OutputBuffer. Si OutputBuffer es null, establezca outputBufferLength en cero.

Valor devuelto

ZwDeviceIoControlFile devuelve STATUS_SUCCESS si los controladores subyacentes llevaron a cabo correctamente la operación solicitada. De lo contrario, el valor devuelto puede ser un código de estado de error propagado desde un controlador subyacente. Entre los códigos de estado de error posibles se incluyen los siguientes:

Observaciones

ZwDeviceIoControlFile proporciona una vista coherente de los datos de entrada y salida al sistema y a los controladores en modo kernel, al tiempo que proporciona aplicaciones y controladores subyacentes con un método dependiente del dispositivo de especificar una interfaz de comunicaciones.

Para obtener más información sobre los códigos de IOCTL_ XXX definidos por el sistema y sobre cómo definir XXX IOCTL_ o FSCTL_xxx valores específicos del controlador, vea Using I/O Control Codes in the Kernel Mode Architecture Guide and Device Input and Output Control Codes en la documentación de Microsoft Windows SDK.

Si el autor de la llamada abrió el archivo para E/S asincrónica (sin FILE_SYNCHRONOUS_XXX conjunto de opciones create/open), el evento especificado, si existe, se establecerá en el estado señalado cuando se complete la operación de control de dispositivo. De lo contrario, el objeto de archivo especificado por FileHandle se establecerá en el estado señalado. Si se especificó un de ApcRoutine, se llama a con los punteros ApcContext y IoStatusBlock.

Los minifiltros deben usar FltDeviceIoControlFile en lugar de ZwDeviceIoControlFile.

Los autores de llamadas de ZwDeviceIoControlFile deben ejecutarse en IRQL = PASSIVE_LEVEL y con API de kernel especiales habilitadas.

Nota Si la llamada a la función ZwDeviceIoControlFile se produce en modo de usuario, debe usar el nombre "NtDeviceIoControlFile" en lugar de "ZwDeviceIoControlFile".

En el caso de las llamadas desde controladores en modo kernel, las versiones **Nt*Xxx*** y **Zw*Xxx*** de una rutina de Servicios del sistema nativo de Windows pueden comportarse de forma diferente en la forma en que controlan e interpretan los parámetros de entrada. Para obtener más información sobre la relación entre las versiones **Nt*Xxx*** y **Zw*Xxx*** de una rutina, vea [Using Nt and Zw Versions of the Native System Services Routines](/windows-hardware/drivers/kernel/using-nt-and-zw-versions-of-the-native-system-services-routines).

Requisitos

Requisito	Valor
cliente mínimo admitido	Windows 2000.
de la plataforma de destino de	Universal
encabezado de	ntifs.h (incluya Ntifs.h, Ntddk.h)
biblioteca de	NtosKrnl.lib
DLL de	NtosKrnl.exe
irQL	PASSIVE_LEVEL (consulte la sección Comentarios)
reglas de cumplimiento de DDI	HwStorPortProhibitedDIs(storport), PowerIrpDDis(wdm)