snmpCleanup 函式 (winsnmp.h)

發行項
08/27/2023

[SNMP 可用於需求一節中指定的作業系統。它在後續版本中可能會變更或無法使用。請改用 Windows 遠端系統管理，這是 WS-Man 的 Microsoft 實作。

SnmpCleanup函式會通知 Microsoft WinSNMP 實作呼叫的 WinSNMP 應用程式不再需要實作的服務。

注意 WinSNMP 應用程式必須先呼叫 SnmpCleanup 函式作為最後一個 WinSNMP 函式，才能終止。

Syntax

SNMPAPI_STATUS SNMPAPI_CALL SnmpCleanup();

傳回值

如果函式成功，傳回值會SNMPAPI_SUCCESS。在 WinSNMP 應用程式成功回收 SnmpStartup 函式之前，WinSNMP 函式的任何其他呼叫會傳回SNMPAPI_FAILURE，並延伸錯誤碼為 SNMPAPI_NOT_INITIALIZED。

如果函式失敗，傳回值會SNMPAPI_FAILURE，但 WinSNMP 應用程式不需要重試 對 SnmpCleanup的呼叫。若要取得延伸的錯誤資訊，請呼叫SnmpGetLastError，在其會話參數中指定Null值。 SnmpGetLastError函式可以傳回下列其中一個錯誤。

傳回碼	描述
SNMPAPI_NOT_INITIALIZED	SnmpStartup函式未順利完成。
SNMPAPI_ALLOC_ERROR	記憶體配置期間發生錯誤。
SNMPAPI_OTHER_ERROR	發生未知或未定義的錯誤。

備註

在 WinSNMP 應用程式呼叫 SnmpCleanup之前，它應該針對每個會話呼叫 SnmpClose 函式一次，因為對 SnmpCreateSession 函式的呼叫而開啟。

當 WinSNMP 應用程式呼叫 SnmpCleanup 函式時，實作會解除配置配置給應用程式的所有資源。不過，建議 WinSNMP 應用程式使用對應至資源的 WinSNMP 函式，釋出實作為它配置的特定資源。如需釋放個別資源的其他資訊，請參閱 SnmpFreeEntity、 SnmpFreeVbl、 SnmpFreeDescriptor、 SnmpFreeCoNtext和 SnmpFreePdu。

如果 WinSNMP 應用程式必須執行緊急結束，而且它會呼叫 SnmpCleanup 而不釋放個別資源，而且不會針對每個開啟的會話呼叫 SnmpClose ，則實作會解除配置配置給 WinSNMP 應用程式的所有資源。不過，若要在實作中啟用這項功能，應用程式仍必須呼叫 SnmpCleanup。

卸載應用程式 DLL 時，不得呼叫SnmpCleanup。

規格需求


最低支援的用戶端	Windows 2000 專業版 [僅限傳統型應用程式]
最低支援的伺服器	Windows 2000 Server [僅限傳統型應用程式]
目標平台	Windows
標頭	winsnmp.h
程式庫	Wsnmp32.lib
Dll	Wsnmp32.dll