Fonction FwpmEngineOpen0 (fwpmk.h)

Article
02/29/2024

La fonction FwpmEngineOpen0 ouvre une session sur le moteur de filtre.

Notes

FwpmEngineOpen0 est une version spécifique de FwpmEngineOpen. Pour plus d’informations , voir PAM Version-Independent noms et Ciblage de versions spécifiques de Windows .

Syntaxe

NTSTATUS FwpmEngineOpen0(
  [in, optional] const wchar_t             *serverName,
  [in]           UINT32                    authnService,
  [in, optional] SEC_WINNT_AUTH_IDENTITY_W *authIdentity,
  [in, optional] const FWPM_SESSION0       *session,
  [out]          HANDLE                    *engineHandle
);

Paramètres

[in, optional] serverName

Pointeur vers une chaîne terminée par null qui spécifie le nom DNS standard du système sur lequel la session du moteur de filtre est ouverte. Les pilotes de légende doivent spécifier NULL pour ce paramètre.

[in] authnService

Service d’authentification à utiliser. Pour obtenir la liste des choix valides pour ce paramètre, consultez Authentication-Service constantes dans la section RPC de la documentation Microsoft Windows SDK. Les pilotes de légende doivent spécifier RPC_C_AUTHN_WINNT ou RPC_C_AUTHN_DEFAULT pour ce paramètre.

[in, optional] authIdentity

Pointeur vers une structure de SEC_WINNT_AUTH_IDENTITY_W qui contient les informations d’identification d’authentification et d’autorisation pour accéder au moteur de filtre. Ce paramètre est ignoré lorsque la fonction FwpmEngineOpen0 est appelée à partir d’un pilote de légende. Les pilotes de légende doivent définir ce paramètre sur NULL.

[in, optional] session

Pointeur vers une structure de FWPM_SESSION0 qui définit des paramètres spécifiques à la session pour la session en cours d’ouverture. Ce pointeur est facultatif et peut avoir la valeur NULL.

[out] engineHandle

Pointeur vers une variable qui reçoit un handle pour la session ouverte vers le moteur de filtre.

Valeur retournée

La fonction FwpmEngineOpen0 retourne l’un des codes NTSTATUS suivants.

Code de retour	Description
STATUS_SUCCESS	Une session sur le moteur de filtre a été ouverte. La variable pointée vers par le paramètre engineHandle contient un handle pour la session ouverte.
Autres codes status	Une erreur est survenue.

Remarques

Un pilote de légende appelle la fonction FwpmEngineOpen0 pour ouvrir une session sur le moteur de filtre. Un handle pour une session ouverte au moteur de filtre est un paramètre obligatoire pour la plupart des fonctions de gestion de la plateforme de filtrage Windows.

Les pilotes de légende n’ont normalement pas besoin d’ouvrir une session sur le moteur de filtre, car les pilotes de légende n’appellent généralement aucune des fonctions de gestion de la plateforme de filtrage Windows .

Pour qu’un pilote de légende ouvre correctement une session sur le moteur de filtre, le moteur de filtre doit être en cours d’exécution au moment où le pilote de légende appelle la fonction FwpmEngineOpen0 . Un pilote de légende peut appeler la fonction FwpmBfeStateGet0 pour obtenir l’état actuel du moteur de filtre. Avant d’appeler FwpmBfeStateGet0, le pilote de légende doit appeler la fonction FwpmBfeStateSubscribeChanges0 pour inscrire une fonction de rappel qui sera appelée chaque fois qu’il y a une modification de l’état du moteur de filtre.

Une fois qu’un pilote de légende a terminé d’accéder au moteur de filtre, il appelle la fonction FwpmEngineClose0 pour fermer la session ouverte au moteur de filtre.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Disponible à partir de Windows Vista.
Plateforme cible	Universal
En-tête	fwpmk.h (incluez Fwpmk.h)
Bibliothèque	Fwpkclnt.lib
IRQL	PASSIVE_LEVEL