Fonction SnmpCleanup (winsnmp.h)

Article
08/27/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 SnmpCleanup informe l’implémentation de Microsoft WinSNMP que l’application WinSNMP appelante ne nécessite plus les services de l’implémentation.

Note Une application WinSNMP doit appeler la fonction SnmpCleanup comme dernière fonction WinSNMP avant qu’elle ne se termine.

Syntaxe

SNMPAPI_STATUS SNMPAPI_CALL SnmpCleanup();

Valeur de retour

Si la fonction réussit, la valeur de retour est SNMPAPI_SUCCESS. Tant que l’application WinSNMP n’a pas correctement rappelé la fonction SnmpStartup , tout autre appel à une fonction WinSNMP retourne SNMPAPI_FAILURE, avec un code d’erreur étendu de SNMPAPI_NOT_INITIALIZED.

Si la fonction échoue, la valeur de retour est SNMPAPI_FAILURE, mais l’application WinSNMP n’a pas besoin de réessayer l’appel à SnmpCleanup. Pour obtenir des informations d’erreur étendues, appelez SnmpGetLastError en spécifiant une valeur NULL dans son paramètre de session . 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_OTHER_ERROR	Une erreur inconnue ou non définie s’est produite.

Remarques

Avant que l’application WinSNMP appelle SnmpCleanup, elle doit appeler la fonction SnmpClose une fois pour chaque session que l’implémentation ouvre à la suite d’un appel à la fonction SnmpCreateSession .

Lorsqu’une application WinSNMP appelle la fonction SnmpCleanup , l’implémentation libère toutes les ressources allouées à l’application. Toutefois, il est recommandé qu’une application WinSNMP libère les ressources spécifiques que l’implémentation lui alloue avec la fonction WinSNMP qui correspond à la ressource. Pour plus d’informations sur la libération de ressources individuelles, consultez SnmpFreeEntity, SnmpFreeVbl, SnmpFreeDescriptor, SnmpFreeContext et SnmpFreePdu.

Si une application WinSNMP doit effectuer une sortie d’urgence et qu’elle appelle SnmpCleanup sans libérer de ressources individuelles et sans appeler SnmpClose pour chaque session ouverte, l’implémentation libère toutes les ressources allouées à l’application WinSNMP. Toutefois, pour activer cette fonctionnalité dans l’implémentation, l’application doit toujours appeler SnmpCleanup.

SnmpCleanup ne doit pas être appelé lorsque la DLL d’application est en cours de déchargement.

Configuration requise


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