FilterVolumeFindFirst, fonction (fltuser.h)

Article
08/23/2023

La fonction FilterVolumeFindFirst retourne des informations sur un volume.

Syntaxe

HRESULT FilterVolumeFindFirst(
  [in]  FILTER_VOLUME_INFORMATION_CLASS dwInformationClass,
  [out] LPVOID                          lpBuffer,
  [in]  DWORD                           dwBufferSize,
  [out] LPDWORD                         lpBytesReturned,
  [out] PHANDLE                         lpVolumeFind
);

Paramètres

[in] dwInformationClass

Type d’informations demandées. Ce paramètre peut prendre les valeurs suivantes.

Valeur	Signification
FilterVolumeBasicInformation	La mémoire tampon pointée par le paramètre lpBuffer reçoit une structure FILTER_VOLUME_BASIC_INFORMATION pour le volume.
FilterVolumeStandardInformation	La mémoire tampon vers laquelle pointe le paramètre lpBuffer reçoit une structure FILTER_VOLUME_STANDARD_INFORMATION pour le volume. Cette structure est disponible à partir de Windows Vista.

[out] lpBuffer

Pointeur vers une mémoire tampon allouée à l’appelant qui reçoit les informations demandées. Le type des informations retournées dans la mémoire tampon est défini par le paramètre dwInformationClass .

[in] dwBufferSize

Taille, en octets, de la mémoire tampon vers laquelle pointe le paramètre lpBuffer . L’appelant doit définir ce paramètre en fonction de la dwInformationClass donnée.

[out] lpBytesReturned

Pointeur vers une variable allouée par l’appelant qui reçoit le nombre d’octets retournés dans la mémoire tampon vers laquelle lpBuffer pointe si l’appel à FilterVolumeFindFirst réussit. Ce paramètre est obligatoire et ne peut pas être NULL.

[out] lpVolumeFind

Pointeur vers une variable allouée par l’appelant qui reçoit un handle de recherche pour le minifiltre si l’appel à FilterVolumeFindFirst réussit ; sinon, elle reçoit INVALID_HANDLE_VALUE. Ce handle de recherche peut être utilisé dans les appels suivants à FilterVolumeFindNext et FilterVolumeFindClose.

Valeur retournée

FilterVolumeFindFirst retourne S_OK s’il retourne correctement des informations sur un volume. Sinon, elle retourne une valeur d’erreur HRESULT, telle que l’une des suivantes :

Code de retour	Description
HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER)	La mémoire tampon pointée par lpBuffer n’est pas assez grande pour contenir les informations demandées. Lorsque cette valeur est retournée, lpBytesReturned contient la taille, en octets, de la mémoire tampon requise pour la structure dwInformationClass donnée.
HRESULT_FROM_WIN32(ERROR_INVALID_PARAMETER)	Une valeur non valide a été spécifiée pour le paramètre dwInformationClass . Par exemple, si FilterVolumeStandardInformation est spécifié pour un système d’exploitation antérieur à Windows Vista, FilterVolumeFindFirst renvoie cette valeur HRESULT.
HRESULT_FROM_WIN32(ERROR_NO_MORE_ITEMS)	Un volume est introuvable dans la liste des volumes connus du gestionnaire de filtres.

Notes

Cette fonction FilterVolumeFindFirst permet de commencer à analyser les volumes connus du gestionnaire de filtres.

FilterVolumeFindFirst ouvre un handle de recherche et retourne des informations sur le premier volume trouvé dans la liste des volumes connus du gestionnaire de filtres. Une fois le handle de recherche établi, utilisez la fonction FilterVolumeFindNext pour rechercher d’autres volumes dans la liste du gestionnaire de filtres. Lorsque le handle de recherche n’est plus nécessaire, fermez-le en appelant FilterVolumeFindClose.

Notez que lorsque vous utilisez FilterVolumeFindFirst et FilterVolumeFindNext pour énumérer la liste des volumes connus du gestionnaire de filtres, il est possible que deux ou plusieurs volumes de la liste portent le même nom. Pour plus d’informations, consultez Présentation des énumérations de volumes avec des noms de volumes en double.