FwpmEngineGetOption0, fonction (fwpmk.h)
La fonction FwpmEngineGetOption0 récupère une option de moteur de filtre.
Syntaxe
NTSTATUS FwpmEngineGetOption0(
[in] HANDLE engineHandle,
[in] FWPM_ENGINE_OPTION option,
[out] FWP_VALUE0 **value
);
Paramètres
[in] engineHandle
Gérer une session ouverte sur le moteur de filtre. Appelez FwpmEngineOpen0 pour ouvrir une session au moteur de filtre.
[in] option
Option à récupérer.
[out] value
Valeur de l’option. Le type de données contenu dans le paramètre valeur sera FWP_UINT32.
Si l’option est FWPM_ENGINE_COLLECT_NET_EVENTS, la valeur est l’une des options suivantes.
| Valeur | Signification |
|---|---|
| 0 | Les événements réseau ne sont pas collectés. |
| 1 | Les événements réseau sont collectés. |
Si option est FWPM_ENGINE_NET_EVENT_MATCH_ANY_KEYWORDS, valeur sera une combinaison au niveau du bit des valeurs suivantes.
| Valeur | Signification |
|---|---|
| FWPM_NET_EVENT_KEYWORD_INBOUND_MCAST (1) | Les événements réseau multidiffusion entrants sont collectés. |
| FWPM_NET_EVENT_KEYWORD_INBOUND_BCAST (2) | Les événements réseau de diffusion entrant ne sont pas collectés. |
Si option est FWPM_ENGINE_PACKET_QUEUING (disponible uniquement dans Windows 8 et Windows Server 2012), valeur sera l’une des suivantes.
| Valeur | Signification |
|---|---|
| FWPM_ENGINE_OPTION_PACKET_QUEUE_NONE (0) | Aucune mise en file d’attente de paquets n’est activée. |
| FWPM_ENGINE_OPTION_PACKET_QUEUE_INBOUND (1) | La mise en file d’attente de paquets entrantes est activée. |
| FWPM_ENGINE_OPTION_PACKET_QUEUE_OUTBOUND (2) | La mise en file d’attente de paquets sortantes est activée. |
Si option est FWPM_ENGINE_MONITOR_IPSEC_CONNECTIONS (disponible uniquement dans Windows 8 et Windows Server 2012), valeur sera l’une des suivantes.
| Valeur | Signification |
|---|---|
| 0 | La fonctionnalité de surveillance des connexions IPsec est désactivée. Aucun événement ou notification de connexion IPsec n’est enregistré. |
| 1 | La fonctionnalité de supervision des connexions IPsec est activée. Les nouveaux événements et notifications de connexion IPsec sont enregistrés. |
Si option est FWPM_ENGINE_TXN_WATCHDOG_TIMEOUT_IN_MSEC (disponible uniquement dans Windows 8 et Windows Server 2012), valeur sera la durée en millisecondes qui spécifie la durée maximale d’une transaction PAM unique. Les transactions prenant plus de temps que cette durée déclenchent un événement de surveillance.
L’option FWPM_ENGINE_NAME_CACHE est réservée à une utilisation interne.
Valeur de retour
| Retourner le code/la valeur | Description |
|---|---|
| ERROR_SUCCESS 0 | L’option a été récupérée avec succès. |
| code d’erreur FWP_E_* 0x80320001 : 0x80320039 | Erreur spécifique à la plateforme de filtrage Windows (PAM). Consultez codes d’erreur PAM pour plus d’informations. |
| RPC_* code d’erreur 0x80010001 : 0x80010122 | Échec de la communication avec le moteur de pare-feu distant ou local. |
| autres codes NTSTATUS | Une erreur s’est produite. |
Remarques
L’appelant doit libérer l’objet retourné par un appel à FwpmFreeMemory0.
L’appelant a besoin de FWPM_ACTRL_READ'accès au moteur de filtre. Pour plus d’informations, consultez contrôle d’accès.
FwpmEngineGetOption0 est une implémentation spécifique de FwpmEngineGetOption. Pour plus d’informations, consultez PAM Version-Independent noms et ciblage de versions spécifiques de Windows.
Exigences
| Exigence | Valeur |
|---|---|
| client minimum pris en charge | Disponible à partir de Windows Vista. |
| plateforme cible | Universel |
| d’en-tête | fwpmk.h |
| bibliothèque | fwpkclnt.lib |
| IRQL | <= PASSIVE_LEVEL |