SnmpListen, fonction (winsnmp.h)

Article
03/06/2024

[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. Utilisez plutôt Windows Remote Management, qui est l’implémentation Microsoft de WS-Man.]

La fonction SnmpListen WinSNMP inscrit une application WinSNMP en tant qu’agent SNMP. Une application agent appelle cette fonction pour informer l’implémentation Microsoft WinSNMP qu’une entité agira dans le rôle d’un agent SNMP. Une application appelle également cette fonction pour informer l’implémentation quand une entité n’agit plus dans ce rôle. La fonction SnmpListen est un élément de l’API WinSNMP, version 2.0.

Syntaxe

SNMPAPI_STATUS SNMPAPI_CALL SnmpListen(
  [in] HSNMP_ENTITY   hEntity,
  [in] SNMPAPI_STATUS lStatus
);

Paramètres

[in] hEntity

Gérez l’entité WinSNMP pour notifier quand l’implémentation De Microsoft WinSNMP reçoit un message de requête SNMP (PDU) entrant. Ce paramètre identifie l’application de l’agent. Pour plus d’informations, consultez les sections Notes et Valeurs de retour suivantes.

Lorsque vous appelez la fonction SnmpCreateSession , vous pouvez spécifier si l’implémentation doit utiliser un message de notification de fenêtre ou une fonction SNMPAPI_CALLBACK pour notifier l’application lorsqu’un message SNMP ou un événement asynchrone est disponible.

[in] lStatus

Spécifie une variable entière longue non signée qui indique si l’entité WinSNMP identifiée par le paramètre hEntity agit dans un rôle d’agent SNMP ou si elle n’agit plus dans ce rôle. Ce paramètre peut prendre les valeurs suivantes.

Valeur	Signification
SNMPAPI_ON	L’entité WinSNMP spécifiée fonctionne dans un rôle d’agent.
SNMPAPI_OFF	L’entité WinSNMP spécifiée ne fonctionne pas dans un rôle d’agent.

Le passage d’une valeur de SNMPAPI_OFF libère à la fois les ressources allouées à l’entité et le port qui lui est attribué. Pour plus d'informations, consultez la section Notes qui suit.

Valeur retournée

Si la fonction réussit, la valeur de retour est SNMPAPI_SUCCESS.

Si la fonction échoue, la valeur de retour est SNMPAPI_FAILURE. Pour obtenir des informations d’erreur étendues, appelez SnmpGetLastError. La fonction SnmpGetLastError peut retourner l’une des erreurs suivantes.

Code de retour	Description
SNMPAPI_NOT_INITIALIZED	La fonction SnmpStartup ne s’est pas terminée correctement.
SNMPAPI_ALLOC_ERROR	Une erreur s’est produite lors de l’allocation de mémoire.
SNMPAPI_ENTITY_INVALID	Le paramètre hEntity n’est pas valide. Ce paramètre doit être un handle retourné par un appel précédent à la fonction SnmpStrToEntity .
SNMPAPI_MODE_INVALID	Le paramètre lStatus n’est pas valide.
SNMPAPI_NOOP	L’entité spécifiée par le paramètre hEntity fonctionne déjà dans le rôle d’un agent SNMP.
SNMPAPI_TL_RESOURCE_ERROR	Il existe une erreur de couche de transport réseau. Impossible de créer un socket pour l’entité spécifiée par le paramètre hEntity .
SNMPAPI_TL_OTHER	Une erreur s’est produite dans la couche de transport réseau lors de la tentative de liaison d’un socket pour l’entité spécifiée par le paramètre hEntity .
SNMPAPI_OTHER_ERROR	Une erreur inconnue ou non définie s’est produite.

Remarques

Lorsque vous spécifiez une entité, vous spécifiez explicitement la famille d’adresses, l’adresse d’interface et le port de l’entité. Cela est dû au fait que WinSNMP affecte ces attributs à chaque entité WinSNMP à la suite d’un appel à la fonction SnmpStrToEntity . L’implémentation utilise les paramètres d’adresse et de port actuellement attribués à l’entité spécifiée par le paramètre hEntity lorsqu’elle envoie des notifications à l’application agent. Pour plus d’informations, consultez SnmpSetPort.

Lorsque vous appelez la fonction SnmpClose pour une session WinSNMP et la fonction SnmpCleanup pour une application WinSNMP, vous devez libérer tous les ports associés aux applications de l’agent WinSNMP.

Pour plus d’informations sur les applications de gestion SNMP et les applications d’agent, consultez Inscription d’une application d’agent SNMP et À propos de SNMP.

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	winsnmp.h
Bibliothèque	Wsnmp32.lib
DLL	Wsnmp32.dll