Fonction SnmpMgrGetTrapEx (mgmtapi.h)

Article
08/24/2023

[SNMP est disponible pour une utilisation dans les systèmes d’exploitation spécifiés dans la section Configuration requise. Il sera peut-être modifié ou indisponible dans les versions ultérieures. Au lieu de cela, utilisez La gestion à distance Windows, qui est l’implémentation Microsoft de WS-Man.]

La fonction SnmpMgrGetTrapEx retourne les données d’interruption en suspens que l’appelant n’a pas reçues si la réception d’interruption est activée. En plus des informations retournées par la fonction SnmpMgrGetTrap , cette fonction étendue retourne l’adresse de la source de transport et la chaîne de communauté de l’interruption. Cette fonction est un élément de l’API gestion SNMP.

Syntaxe

BOOL SNMP_FUNC_TYPE SnmpMgrGetTrapEx(
  [out] AsnObjectIdentifier *enterprise,
  [out] AsnNetworkAddress   *agentAddress,
  [out] AsnNetworkAddress   *sourceAddress,
  [out] AsnInteger          *genericTrap,
  [out] AsnInteger          *specificTrap,
  [out] AsnOctetString      *community,
  [out] AsnTimeticks        *timeStamp,
  [out] RFC1157VarBindList  *variableBindings
);

Paramètres

[out] enterprise

Pointeur vers une structure AsnObjectIdentifier pour recevoir l’entreprise qui a généré l’interruption SNMP.

[out] agentAddress

Pointeur vers une variable pour recevoir l’adresse de l’agent qui a généré l’interruption SNMP ; ces informations sont récupérées à partir de l’unité de données de protocole SNMP (PDU).

[out] sourceAddress

Pointeur vers une variable pour recevoir l’adresse de l’agent qui a généré l’interruption SNMP ; ces informations sont récupérées à partir du transport réseau.

[out] genericTrap

Pointeur vers une variable pour recevoir un indicateur de l’interruption générique. Ce paramètre peut prendre les valeurs suivantes.

Valeur	Signification
SNMP_GENERICTRAP_COLDSTART	L’agent initialise des entités de protocole en mode managé. Il peut modifier des objets dans sa vue.
SNMP_GENERICTRAP_WARMSTART	L’agent se réinitialise, mais il ne modifie pas les objets dans sa vue.
SNMP_GENERICTRAP_LINKDOWN	Une interface attachée est passée de l’état haut à l’état bas. La première variable de la liste des liaisons de variables identifie l’interface.
SNMP_GENERICTRAP_LINKUP	Une interface attachée est passée de l’état bas à l’état haut. La première variable de la liste des liaisons de variables identifie l’interface.
SNMP_GENERICTRAP_AUTHFAILURE	Une entité SNMP a envoyé un message SNMP, mais elle a faussement prétendu appartenir à une communauté connue.
SNMP_GENERICTRAP_EGPNEIGHLOSS	Un homologue EGP est passé à l’état down. La première variable de la liste des liaisons de variables identifie l’adresse IP de l’homologue EGP.
SNMP_GENERICTRAP_ENTERSPECIFIC	Un événement extraordinaire s’est produit. Il est identifié dans le paramètre specificTrap avec une valeur spécifique à l’entreprise.

[out] specificTrap

Pointeur vers une variable pour recevoir un indicateur de l’interruption spécifique générée.

[out] community

Pointeur vers une structure AsnOctetString pour recevoir la chaîne de communauté de l’interruption SNMP générée.

[out] timeStamp

Pointeur vers une variable pour recevoir l’horodatage.

[out] variableBindings

Pointeur vers une structure SnmpVarBindList pour recevoir la liste des liaisons de variables.

Valeur retournée

Si la fonction retourne une interruption, la valeur de retour est différente de zéro.

Vous devez appeler la fonction SnmpMgrGetTrapEx à plusieurs reprises jusqu’à ce qu’elle retourne zéro. La fonction peut également retourner les codes d’erreur suivants.

Code de retour	Description
SNMP_MGMTAPI_TRAP_ERRORS	Indique que des erreurs ont été rencontrées ; les pièges ne sont pas accessibles.
SNMP_MGMTAPI_NOTRAPS	Indique qu’aucune interruption n’est disponible.
SNMP_MEM_ALLOC_ERROR	Indique une erreur d’allocation de mémoire.

Remarques

L’application doit toujours appeler la fonction SnmpMgrTrapListen avant d’appeler la fonction SnmpMgrGetTrapEx . En effet, le handle d’événement vers lequel pointe le paramètre phTrapAvailable de la fonction SnmpMgrTrapListen permet l’acquisition pilotée par les événements des interruptions SNMP. L’API gestion SNMP signale un événement d’application lorsque le service d’interruption SNMP envoie une interruption.

L’application peut également interroger la fonction SnmpMgrGetTrapEx pour rechercher des interruptions à intervalles réguliers. Dans ce cas, l’application doit appeler à plusieurs reprises SnmpMgrGetTrapEx jusqu’à ce que la fonction retourne zéro.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	mgmtapi.h
Bibliothèque	Mgmtapi.lib
DLL	Mgmtapi.dll