Función NtQueryDirectoryFile (ntifs.h)

Artículo
08/07/2023

La rutina NtQueryDirectoryFile devuelve varios tipos de información sobre los archivos en el directorio especificado por un identificador de archivo determinado.

Sintaxis

__kernel_entry NTSYSCALLAPI NTSTATUS NtQueryDirectoryFile(
  [in]           HANDLE                 FileHandle,
  [in, optional] HANDLE                 Event,
  [in, optional] PIO_APC_ROUTINE        ApcRoutine,
  [in, optional] PVOID                  ApcContext,
  [out]          PIO_STATUS_BLOCK       IoStatusBlock,
  [out]          PVOID                  FileInformation,
  [in]           ULONG                  Length,
  [in]           FILE_INFORMATION_CLASS FileInformationClass,
  [in]           BOOLEAN                ReturnSingleEntry,
  [in, optional] PUNICODE_STRING        FileName,
  [in]           BOOLEAN                RestartScan
);

Parámetros

[in] FileHandle

Identificador devuelto por NtCreateFile o NtOpenFile para el objeto de archivo que representa el directorio para el que se solicita información. El objeto de archivo debe haberse abierto para E/S asincrónica si el autor de la llamada especifica un valor distinto de NULL para Event o ApcRoutine.

[in, optional] Event

Identificador opcional para 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 puede ser NULL. Debe ser NULL si el autor de la llamada esperará a que FileHandle se establezca en el estado Signaled.

[in, optional] ApcRoutine

Una dirección de una rutina de APC opcional proporcionada por el autor de la llamada que se llamará cuando se complete la operación solicitada. Este parámetro es opcional y puede ser NULL. Si hay un objeto de finalización de E/S asociado al objeto de archivo, este parámetro debe ser NULL.

[in, optional] ApcContext

Puntero opcional a un área de contexto determinada por el autor de la llamada si el autor de la llamada proporciona un APC o si un objeto de finalización de E/S está asociado al objeto de archivo. Cuando se completa la operación, este contexto se pasa al APC, si se ha especificado uno, o 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 puede ser 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 estructura de IO_STATUS_BLOCK que recibe el estado de finalización final e información sobre la operación. Para llamadas correctas que devuelven datos, el número de bytes escritos en el búfer FileInformation se devuelve en el miembro Information de la estructura.

[out] FileInformation

Puntero a un búfer que recibe la información deseada sobre el archivo. La estructura de la información devuelta en el búfer se define mediante el parámetro FileInformationClass .

[in] Length

Tamaño, en bytes, del búfer al que apunta FileInformation. El autor de la llamada debe establecer este parámetro según la clase FileInformationClass especificada.

[in] FileInformationClass

Tipo de información que se va a devolver sobre los archivos del directorio. Tipo de información que se va a devolver sobre los archivos del directorio. Consulte el parámetro FileInformationClass de NtQueryDirectoryFileEx para obtener la lista de valores posibles.

[in] ReturnSingleEntry

Establezca en TRUE si solo se debe devolver una única entrada; de lo contrario, FALSE . Si este parámetro es TRUE, NtQueryDirectoryFile devuelve solo la primera entrada que se encuentra.

[in, optional] FileName

Puntero opcional a una cadena Unicode asignada por el autor de la llamada que contiene el nombre de un archivo (o varios archivos, si se usan caracteres comodín) dentro del directorio especificado por FileHandle. Este parámetro es opcional y puede ser NULL.

Si FileName no es NULL, solo los archivos cuyos nombres coincidan con la cadena FileName se incluyen en el examen del directorio. Si FileName es NULL, se incluyen todos los archivos.

FileName se usa como una expresión de búsqueda y se captura en la primera llamada a NtQueryDirectoryFile para un identificador determinado. Las llamadas posteriores a NtQueryDirectoryFile usarán la expresión de búsqueda establecida en la primera llamada. Se omitirá el parámetro FileName pasado a las llamadas posteriores.

[in] RestartScan

Establezca en TRUE si el examen se va a iniciar en la primera entrada del directorio. Establézcalo en FALSE si reanuda el examen desde una llamada anterior.

Cuando se llama a la rutina NtQueryDirectoryFile para un identificador determinado, el parámetro RestartScan se trata como si estuviera establecido en TRUE, independientemente de su valor. En las llamadas a NtQueryDirectoryFile posteriores, se respeta el valor del parámetro RestartScan .

Valor devuelto

La rutina NtQueryDirectoryFiledevuelve STATUS_SUCCESS o un estado de error adecuado. El conjunto de valores de estado de error que se pueden devolver es específico del sistema de archivos. NtQueryDirectoryFiletambién devuelve el número de bytes escritos realmente en el búfer FileInformation especificado en el miembro Information de IoStatusblock. Consulte NtQueryDirectoryFileEx para obtener una lista de algunos códigos de error posibles.

Comentarios

La rutina NtQueryDirectoryFile devuelve información sobre los archivos contenidos en el directorio representado por FileHandle.

Si se proporciona, el valor del parámetro FileName determina las entradas que se incluyen en el directorio buscan todas las llamadas posteriores a NtQueryDirectoryFile para un fileHandle determinado.

Si hay al menos una entrada coincidente, NtQueryDirectoryFile crea una estructura FILE_XXX_INFORMATION para cada entrada y las almacena en el búfer.

Suponiendo que se encuentre al menos una entrada de directorio coincidente, el número de entradas para las que se devuelve información es el *menor de lo siguiente:

Una entrada, si ReturnSingleEntry es TRUE y FileName es NULL.
Número de entradas que coinciden con la cadena FileName , si FileName no es NULL. (Tenga en cuenta que si la cadena no contiene caracteres comodín, puede haber como máximo una entrada coincidente).
Número de entradas cuya información se ajusta al búfer especificado.
Número de entradas contenidas en el directorio.

En la primera llamada a NtQueryDirectoryFile, si la estructura creada para la primera entrada encontrada es demasiado grande para caber en el búfer de salida, la rutina escribe la parte fija de la estructura en el búfer de salida. A continuación, la rutina escribe en el búfer de salida tanto de la cadena FileName como se ajuste. (La parte fija de la estructura consta de todos los campos excepto la cadena FileName final. En la primera llamada, pero no en las llamadas posteriores, el sistema de E/S garantiza que el búfer es lo suficientemente grande como para contener la parte fija de la estructura FILE_XXX adecuada_INFORMATION ). Cuando esto sucede, NtQueryDirectoryFile devuelve un valor de estado adecuado, como STATUS_BUFFER_OVERFLOW.

En cada llamada, NtQueryDirectoryFile devuelve tantas estructuras FILE_XXX_INFORMATION (una por entrada de directorio) como se puede contener por completo en el búfer al que apunta FileInformation. En la primera llamada, NtQueryDirectoryFile devuelve STATUS_SUCCESS solo si el búfer de salida contiene al menos una estructura completa. En las llamadas posteriores, si el búfer de salida no contiene estructuras, NtQueryDirectoryFile devuelve STATUS_SUCCESS pero establece IoStatusblock-Information> = 0 para notificar al autor de la llamada de esta condición. En este caso, el autor de la llamada debe asignar un búfer mayor y volver a llamar a NtQueryDirectoryFile . No se notifica información sobre las entradas restantes. Por lo tanto, excepto en los casos enumerados anteriormente en los que solo se devuelve una entrada, se debe llamar a NtQueryDirectoryFile al menos dos veces para enumerar el contenido de todo un directorio.

Al llamar a NtQueryDirectoryFile, es posible que vea los cambios realizados en el directorio que se producen en paralelo con las llamadas a NtQueryDirectoryFile . Este comportamiento depende de la implementación del sistema de archivos subyacente.

La llamada final a NtQueryDirectoryFile devuelve un búfer de salida vacío e informa de un valor de estado adecuado, como STATUS_NO_MORE_FILES.

Si se llama a NtQueryDirectoryFile varias veces en el mismo directorio y alguna otra operación cambia el contenido de ese directorio, es posible que se vean los cambios, en función del tiempo de las operaciones.

NtQueryDirectoryFiledevuelve cero en cualquier miembro de una estructura FILE_XXX_INFORMATION que no es compatible con el sistema de archivos.

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

Para obtener información sobre otras rutinas de consulta de información de archivos, vea Objetos de archivo.

Nota

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

En el caso de las llamadas desde controladores en modo kernel, las versiones NtXXX y ZwXXX de una rutina de Windows Native System Services 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 NtXXX y ZwXXX de una rutina, vea Using Nt and Zw Versions of the Native System Services Routines.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows XP
Plataforma de destino	Universal
Encabezado	ntifs.h (incluya Ntifs.h)
Library	NtosKrnl.lib
Archivo DLL	NtosKrnl.exe
IRQL	PASSIVE_LEVEL (consulte la sección Comentarios)
Reglas de cumplimiento de DDI	HwStorPortProhibitedDIs, PowerIrpDDis