Fonction FilterInstanceGetInformation (fltuser.h)

Article
08/23/2023

La fonction FilterInstanceGetInformation retourne différents types d’informations sur un minifiltre instance.

Syntaxe

HRESULT FilterInstanceGetInformation(
  [in]  HFILTER_INSTANCE           hInstance,
  [in]  INSTANCE_INFORMATION_CLASS dwInformationClass,
  [out] LPVOID                     lpBuffer,
  [in]  DWORD                      dwBufferSize,
  [out] LPDWORD                    lpBytesReturned
);

Paramètres

[in] hInstance

Handle retourné par un appel précédent à FilterInstanceCreate.

[in] dwInformationClass

Type de instance structure d’informations retournée. Ce paramètre doit contenir l’une des valeurs suivantes.

Valeur	Signification
InstanceBasicInformation	Retourne une structure de INSTANCE_BASIC_INFORMATION pour le instance.
InstanceFullInformation	Retourne une structure INSTANCE_FULL_INFORMATION pour le instance.
InstancePartialInformation	Retourne une structure INSTANCE_PARTIAL_INFORMATION pour le instance.
InstanceAggregateStandardInformation	Retourne une structure INSTANCE_AGGREGATE_STANDARD_INFORMATION pour le instance. La partie LegacyFilter de la structure est utilisée à partir de Windows 8. 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 à l’appelant qui reçoit le nombre d’octets retournés dans la mémoire tampon vers laquelle lpBuffer pointe si l’appel à FilterInstanceGetInformation réussit. Ce paramètre est obligatoire et ne peut pas avoir la valeur NULL.

Valeur retournée

FilterInstanceGetInformation retourne S_OK en cas de réussite. Sinon, il retourne une valeur d’erreur HRESULT, telle que l’une des valeurs 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 InstanceAggregateStandardInformation est spécifié pour un système d’exploitation antérieur à Windows Vista, FilterInstanceGetInformation retourne cette valeur HRESULT.

Remarques

Avec un handle à un minifiltre instance, cette routine retourne des informations sur le minifiltre instance. Le type d’informations instance retournées est déterminé par le paramètre dwInformationClass.

FilterInstanceGetInformation est l’équivalent Win32 de FltGetInstanceInformation.