SnmpMgrTrapListen, fonction (mgmtapi.h)
[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 SnmpMgrTrapListen enregistre la capacité d’une application de gestionnaire SNMP à recevoir des interruptions SNMP du service d’interruption SNMP. Cette fonction est un élément de l’API de gestion SNMP.
Syntaxe
BOOL SNMP_FUNC_TYPE SnmpMgrTrapListen(
[out] HANDLE *phTrapAvailable
);
Paramètres
[out] phTrapAvailable
Pointeur vers un handle d’événement pour recevoir une indication indiquant qu’il existe des interruptions disponibles et que l’application doit appeler la fonction SnmpMgrGetTrap .
Valeur retournée
Si la fonction réussit, la valeur de retour est différente de zéro.
Si la fonction échoue, la valeur de retour est égale à zéro. Pour obtenir des informations d’erreur étendues, appelez GetLastError, qui peut retourner l’un des codes d’erreur suivants.
| Code de retour | Description |
|---|---|
|
Indique une erreur d’allocation de mémoire. |
|
Indique que cette fonction a déjà été appelée. |
|
Indique qu’une ou plusieurs erreurs se sont produites ; les pièges ne sont pas accessibles. L’application peut tenter d’appeler à nouveau la fonction. |
Cette fonction peut également retourner d’autres erreurs système.
Remarques
Il est important de noter que pour les utilisateurs qui ne sont pas administrateurs, la fonction SnmpMgrTrapListen réussit uniquement si le service d’interruption SNMP a été démarré.
L’application doit toujours appeler la fonction SnmpMgrTrapListen avant d’appeler la fonction SnmpMgrGetTrap . Cela est dû au fait que le handle d’événement pointé par le paramètre phTrapAvailable permet l’acquisition pilotée par les événements des interruptions SNMP. L’API de gestion SNMP signale l’événement d’une application lorsque le service d’interruption SNMP remet une interruption.
L’application peut également interroger la fonction SnmpMgrGetTrap à la recherche d’interruptions à intervalles réguliers. Dans ce cas, l’application doit appeler snmpMgrGetTrap à plusieurs reprises jusqu’à ce que la fonction retourne zéro.
Windows Server 2003 : Les applications gestionnaires SNMP peuvent appeler SnmpMgrClose avec un paramètre de sessionNULL pour propre les ressources associées à un appel réussi à la fonction SnmpMgrTrapListen. Notez toutefois que si votre application est une DLL, elle ne doit pas appeler SnmpMgrClose à partir de sa fonction de point d’entrée DllMain .
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 |
Voir aussi
Vue d’ensemble du protocole SNMP (Simple Network Management Protocol)