SnmpCleanup-Funktion (winsnmp.h)

Artikel
08/27/2023

[SNMP ist für die Verwendung in den im Abschnitt Anforderungen angegebenen Betriebssystemen verfügbar. Es kann in nachfolgenden Versionen geändert oder entfernt werden. Verwenden Sie stattdessen die Windows-Remoteverwaltung, die Microsoft-Implementierung von WS-Man.]

Die SnmpCleanup-Funktion informiert die Microsoft WinSNMP-Implementierung darüber, dass die aufrufende WinSNMP-Anwendung die Dienste der Implementierung nicht mehr benötigt.

Hinweis Eine WinSNMP-Anwendung muss die SnmpCleanup-Funktion als letzte WinSNMP-Funktion aufrufen, bevor sie beendet wird.

Syntax

SNMPAPI_STATUS SNMPAPI_CALL SnmpCleanup();

Rückgabewert

Wenn die Funktion erfolgreich ist, wird der Rückgabewert SNMPAPI_SUCCESS. Bis die WinSNMP-Anwendung erfolgreich die SnmpStartup-Funktion zurückruft, gibt jeder andere Aufruf einer WinSNMP-Funktion SNMPAPI_FAILURE mit dem erweiterten Fehlercode SNMPAPI_NOT_INITIALIZED zurück.

Wenn die Funktion fehlschlägt, wird der Rückgabewert SNMPAPI_FAILURE, aber die WinSNMP-Anwendung muss den Aufruf von SnmpCleanup nicht wiederholen. Rufen Sie SnmpGetLastError auf, um erweiterte Fehlerinformationen zu erhalten, und geben Sie einen NULL-Wert im Sitzungsparameter an. Die SnmpGetLastError-Funktion kann einen der folgenden Fehler zurückgeben.

Rückgabecode	Beschreibung
SNMPAPI_NOT_INITIALIZED	Die SnmpStartup-Funktion wurde nicht erfolgreich abgeschlossen.
SNMPAPI_ALLOC_ERROR	Während der Speicherbelegung ist ein Fehler aufgetreten.
SNMPAPI_OTHER_ERROR	Es ist ein unbekannter oder nicht definierter Fehler aufgetreten.

Hinweise

Bevor die WinSNMP-Anwendung SnmpCleanup aufruft, sollte sie die SnmpClose-Funktion einmal für jede Sitzung aufrufen, die die Implementierung als Ergebnis eines Aufrufs der SnmpCreateSession-Funktion öffnet.

Wenn eine WinSNMP-Anwendung die SnmpCleanup-Funktion aufruft, wird die Zuordnung aller ressourcen aufgehoben, die der Anwendung zugeordnet sind. Es wird jedoch empfohlen, dass eine WinSNMP-Anwendung die spezifischen Ressourcen freigibt, die die Implementierung ihr mit der WinSNMP-Funktion zur Verfügung stellt, die der Ressource entspricht. Weitere Informationen zum Freigeben einzelner Ressourcen finden Sie unter SnmpFreeEntity, SnmpFreeVbl, SnmpFreeDescriptor, SnmpFreeContext und SnmpFreePdu.

Wenn eine WinSNMP-Anwendung einen Notausgang ausführen muss und SnmpCleanup aufruft, ohne einzelne Ressourcen freizugeben und snmpClose für jede geöffnete Sitzung aufzurufen, wird die Zuordnung aller Ressourcen aufgehoben, die der WinSNMP-Anwendung zugeordnet sind. Um diese Funktionalität in der Implementierung zu aktivieren, muss die Anwendung jedoch weiterhin SnmpCleanup aufrufen.

SnmpCleanup darf nicht aufgerufen werden, wenn die Anwendungs-DLL gerade entladen wird.

Anforderungen


Unterstützte Mindestversion (Client)	Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	winsnmp.h
Bibliothek	Wsnmp32.lib
DLL	Wsnmp32.dll