Fonction FwpmEngineOpen0 (fwpmu.h)

Article
08/23/2023

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

Syntaxe

DWORD 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

Type : const wchar_t*

Cette valeur doit être NULL.

[in] authnService

Type : UINT32

Spécifie le service d’authentification à utiliser. Les services autorisés sont RPC_C_AUTHN_WINNT et RPC_C_AUTHN_DEFAULT.

[in, optional] authIdentity

Type : SEC_WINNT_AUTH_IDENTITY_A*

Informations d’identification d’authentification et d’autorisation pour accéder au moteur de filtre. Ce pointeur est facultatif et peut être NULL. Si ce pointeur a la valeur NULL, les informations d’identification du thread appelant sont utilisées.

[in, optional] session

Type : FWPM_SESSION0*

Paramètres spécifiques à la session pour la session en cours d’ouverture. Ce pointeur est facultatif et peut être NULL.

[out] engineHandle

Type : HANDLE*

Handle pour la session ouverte vers le moteur de filtre.

Valeur retournée

Type : DWORD

Code/valeur de retour	Description
ERROR_SUCCESS 0	La session a démarré avec succès.
FWP_E_ALREADY_EXISTS 0x80320009	Une session avec la sessionKey spécifiée est déjà ouverte.
code d’erreur FWP_E_* 0x80320001—0x80320039	Une erreur spécifique à la plateforme de filtrage Windows (PAM). Pour plus d’informations, consultez Codes d’erreur PAM .
code d’erreur RPC_* 0x80010001—0x80010122	Échec de la communication avec le moteur de pare-feu distant ou local.

Notes

Une application utilisateur doit appeler FwpmEngineOpen0 pour obtenir un handle pour ouvrir une session dans le moteur de filtre avant d’ajouter ou de supprimer des objets de filtre. Un handle pour une session ouverte au moteur de filtre est également nécessaire pour la plupart des autres fonctions de gestion de la plateforme de filtrage Windows.

La session est automatiquement fermée à la fin du programme. Pour fermer explicitement une session, appelez FwpmEngineClose0.

Si session. indicateurs est défini sur FWPM_SESSION_FLAG_DYNAMIC, tous les objets PAM ajoutés pendant la session sont automatiquement supprimés à la fin de la session. Si la session n’est pas dynamique, l’appelant doit supprimer explicitement tous les objets PAM ajoutés pendant la session.

L’appelant a besoin d’un accès FWPM_ACTRL_OPEN au moteur de filtre. Pour plus d’informations, consultez Access Control.

FwpmEngineOpen0 est destiné à être utilisé en mode sans emprunt d’identité uniquement.

FwpmEngineOpen0 est une implémentation spécifique de FwpmEngineOpen. Pour plus d’informations , consultez WFP Version-Independent Names and Targeting Specific Versions of Windows .

Exemples

L’exemple C++ suivant utilise FwpmEngineOpen0 pour ouvrir une session de filtre.

// Open a session to the filter engine
        
HANDLE    engineHandle = NULL;
DWORD    result = ERROR_SUCCESS; 

printf("Opening the filter engine.\n");
        
result = FwpmEngineOpen0(
    NULL, 
    RPC_C_AUTHN_WINNT, 
    NULL,
    NULL, 
    &engineHandle );

if (result != ERROR_SUCCESS)
    printf("FwpmEngineOpen0 failed. Return value: %d.\n", result); 
else
    printf("Filter engine opened successfully.\n");

Spécifications


Client minimal pris en charge	Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2008 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	fwpmu.h
Bibliothèque	Fwpuclnt.lib
DLL	Fwpuclnt.dll