ZwQueryDirectoryFileEx, fonction (ntifs.h)

Article
08/07/2023

La routine ZwQueryDirectoryFileEx retourne diverses informations sur les fichiers du répertoire spécifié par un handle de fichier donné.

Syntaxe

NTSYSAPI NTSTATUS ZwQueryDirectoryFileEx(
  [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]           ULONG                  QueryFlags,
  [in, optional] PUNICODE_STRING        FileName
);

Paramètres

[in] FileHandle

Handle retourné par ZwCreateFile ou ZwOpenFile pour l’objet file qui représente le répertoire pour lequel les informations sont demandées. L’objet file doit avoir été ouvert pour les E/S asynchrones si l’appelant spécifie une valeur non NULL pour Event ou ApcRoutine.

[in, optional] Event

Handle facultatif pour un événement créé par l’appelant. Si ce paramètre est fourni, l’appelant est placé dans un état d’attente jusqu’à ce que l’opération demandée soit terminée et que l’événement donné soit défini sur l’état Signaled. Ce paramètre est facultatif et peut être NULL. Elle doit être NULL si l’appelant attend que fileHandle soit défini sur l’état Signaled.

[in, optional] ApcRoutine

Adresse d’une routine APC facultative fournie par l’appelant à appeler une fois l’opération demandée terminée. Ce paramètre est facultatif et peut être NULL. Si un objet d’achèvement d’E/S est associé à l’objet file, ce paramètre doit être NULL.

[in, optional] ApcContext

Pointeur facultatif vers une zone de contexte déterminée par l’appelant si l’appelant fournit un APC ou si un objet d’achèvement d’E/S est associé à l’objet fichier. Une fois l’opération terminée, ce contexte est transmis à l’APC, s’il en a été spécifié, ou est inclus dans le message d’achèvement que le Gestionnaire d’E/S publie sur l’objet d’achèvement d’E/S associé.

Ce paramètre est facultatif et peut être NULL. Elle doit être NULL si ApcRoutine a la valeur NULL et qu’aucun objet d’achèvement d’E/S n’est associé à l’objet file.

[out] IoStatusBlock

Pointeur vers une structure de IO_STATUS_BLOCK qui reçoit l’achèvement final status et des informations sur l’opération. Pour les appels réussis qui retournent des données, le nombre d’octets écrits dans la mémoire tampon FileInformation est retourné dans le membre Information de la structure.

[out] FileInformation

Pointeur vers une mémoire tampon de sortie qui reçoit les informations souhaitées sur le fichier. La structure des informations retournées dans la mémoire tampon est définie par le paramètre FileInformationClass .

[in] Length

Taille, en octets, de la mémoire tampon pointée par FileInformation. L’appelant doit définir ce paramètre en fonction de la FileInformationClass donnée.

[in] FileInformationClass

Type d’informations à retourner sur les fichiers du répertoire. Pour obtenir la liste des valeurs possibles, consultez le paramètre FileInformationClass de NtQueryDirectoryFileEx .

[in] QueryFlags

Un ou plusieurs des indicateurs contenus dans SL_QUERY_DIRECTORY_MASK. Pour obtenir la liste des valeurs possibles, consultez le paramètre QueryFlags de NtQueryDirectoryFileEx .

[in, optional] FileName

Pointeur facultatif vers une chaîne Unicode allouée à l’appelant contenant le nom d’un fichier (ou de plusieurs fichiers, si des caractères génériques sont utilisés) dans le répertoire spécifié par FileHandle. Ce paramètre est facultatif :

Si FileName n’a pas la valeur NULL, seuls les fichiers dont le nom correspond à la chaîne FileName sont inclus dans l’analyse du répertoire.
Si FileName a la valeur NULL :
- Si SL_RETURN_SINGLE_ENTRY n’est pas défini dans QueryFlags, tous les fichiers sont inclus.
- Si SL_RETURN_SINGLE_ENTRY est défini, un seul fichier est inclus.

FileName est utilisé comme expression de recherche et est capturé lors du tout premier appel à ZwQueryDirectoryFileEx pour un handle donné. Les appels suivants à ZwQueryDirectoryFileEx utilisent l’expression de recherche définie dans le premier appel. Le paramètre FileName passé aux appels suivants est ignoré.

Valeur retournée

ZwQueryDirectoryFileEx retourne STATUS_SUCCESS ou une status d’erreur appropriée. L’ensemble des valeurs d’erreur status qui peuvent être retournées est spécifique au système de fichiers. ZwQueryDirectoryFileEx retourne également le nombre d’octets réellement écrits dans la mémoire tampon FileInformation donnée dans le membre Informationd’IoStatusBlock. Pour obtenir la liste des codes d’erreur possibles, consultez NtQueryDirectoryFileEx .

Remarques

ZwQueryDirectoryFileEx retourne des informations sur les fichiers contenus dans le répertoire représenté par FileHandle.

S’il est fourni, FileName détermine les entrées incluses dans l’analyse du répertoire pour tous les appels suivants à ZwQueryDirectoryFileEx pour un FileHandle donné.

S’il existe au moins une entrée correspondante, ZwQueryDirectoryFileEx crée une structure FILE_XXX_INFORMATION pour chaque entrée et les stocke dans la mémoire tampon.

En supposant qu’au moins une entrée de répertoire correspondant soit trouvée, le nombre d’entrées pour lesquelles les informations sont retournées est le plus petit des éléments suivants :

Une entrée, si SL_RETURN_SINGLE_ENTRY est défini dans QueryFlags et FileName a la valeur NULL.
Nombre d’entrées qui correspondent à la chaîne FileName , si FileName n’a pas la valeur NULL. Si la chaîne ne contient pas de caractères génériques, il peut y avoir au maximum une entrée correspondante.
Nombre d’entrées dont les informations sont insérées dans la mémoire tampon spécifiée.
Nombre d’entrées contenues dans le répertoire.

Lors du premier appel à ZwQueryDirectoryFileEx, si la structure qu’il crée pour la première entrée trouvée est trop grande pour tenir dans la mémoire tampon de sortie, cette routine effectue les opérations suivantes :

Écrit la partie fixe de la structure dans la mémoire tampon de sortie de FileInformation. La partie fixe se compose de tous les champs à l’exception de la chaîne FileName finale. Lors du premier appel, mais pas lors des appels suivants, le système d’E/S garantit que la mémoire tampon est suffisamment grande pour contenir la partie fixe de la structure FILE_XXX_INFORMATION appropriée.
Écrit dans la mémoire tampon de sortie autant de la chaîne FileName que vous le souhaitez.
Retourne une valeur de status appropriée, telle que STATUS_BUFFER_OVERFLOW.

À chaque appel, ZwQueryDirectoryFileEx retourne autant de structures FILE_XXX_INFORMATION (une par entrée de répertoire) que peuvent être contenues entièrement dans la mémoire tampon pointée par FileInformation :

Lors du premier appel, ZwQueryDirectoryFileEx retourne STATUS_SUCCESS uniquement si la mémoire tampon de sortie contient au moins une structure complète.
Lors des appels suivants, si la mémoire tampon de sortie ne contient aucune structure, ZwQueryDirectoryFileEx retourne STATUS_SUCCESS mais définit IoStatusBlock-Information> = 0 pour informer l’appelant de cette condition. Dans ce cas, l’appelant doit allouer une mémoire tampon plus grande et appeler à nouveau ZwQueryDirectoryFileEx . Aucune information sur les entrées restantes n’est signalée. Ainsi, sauf dans les cas listés ci-dessus où une seule entrée est retournée, ZwQueryDirectoryFileEx doit être appelé au moins deux fois pour énumérer le contenu d’un répertoire entier.

Lorsque vous appelez ZwQueryDirectoryFileEx, vous pouvez voir des modifications apportées au répertoire qui se produisent en parallèle avec les appels ZwQueryDirectoryFileEx . Ce comportement dépend de l’implémentation du système de fichiers sous-jacent.

L’appel final à ZwQueryDirectoryFileEx retourne une mémoire tampon de sortie vide et signale une valeur de status appropriée, telle que STATUS_NO_MORE_FILES.

Si ZwQueryDirectoryFileEx est appelé plusieurs fois dans le même répertoire et qu’une autre opération modifie le contenu de ce répertoire, les modifications peuvent être visibles ou non, selon le moment des opérations.

ZwQueryDirectoryFileEx retourne zéro dans n’importe quel membre d’une structure FILE_XXX_INFORMATION qui n’est pas prise en charge par le système de fichiers.

Les appelants de ZwQueryDirectoryFileEx doivent s’exécuter sur IRQL = PASSIVE_LEVEL et avec des API de noyau spéciales activées.

Pour plus d’informations sur d’autres routines de requête d’informations sur les fichiers, consultez Objets de fichier.

Notes

Si l’appel à la fonction ZwQueryDirectoryFileEx se produit en mode utilisateur, vous devez utiliser le nom « NtQueryDirectoryFileEx » au lieu de « ZwQueryDirectoryFileEx ».

Pour les appels provenant de pilotes en mode noyau, les versions NtXxx et ZwXxx d’une routine Windows Native System Services peuvent se comporter différemment dans la façon dont elles gèrent et interprètent les paramètres d’entrée. Pour plus d’informations sur la relation entre les versions NtXxx et ZwXxx d’une routine, consultez Using Nt and Zw Versions of the Native System Services Routines.