SnmpClose 関数 (winsnmp.h)
[SNMP は、[要件] セクションで指定したオペレーティング システムで使用できます。 今後のバージョンでは変更されるか、利用できなくなる場合もあります。 代わりに、WS-Man の Microsoft 実装である Windows リモート管理を使用します。
SnmpClose 関数を使用すると、Microsoft WinSNMP の実装で、WinSNMP セッションに関連付けられているメモリ、リソース、およびデータ構造の割り当てを解除できます。 WinSNMP SnmpClose 関数は、 SnmpCreateSession 関数の呼び出しの結果として開かれた実装の通信メカニズムも閉じます。
構文
SNMPAPI_STATUS SNMPAPI_CALL SnmpClose(
[in] HSNMP_SESSION session
);
パラメーター
[in] session
WinSNMP セッションを処理して閉じます。
戻り値
関数が成功した場合、戻り値はSNMPAPI_SUCCESS。
関数が失敗した場合、戻り値はSNMPAPI_FAILURE。 拡張エラー情報を取得するには、セッション パラメーターに NULL 値を指定して SnmpGetLastError を呼び出します。 SnmpGetLastError 関数は、次のいずれかのエラーを返すことができます。
| リターン コード | 説明 |
|---|---|
|
SnmpStartup 関数が正常に完了しませんでした。 |
|
メモリ割り当て中にエラーが発生しました。 |
|
セッション パラメーターが無効です。 |
|
不明または未定義のエラーが発生しました。 |
注釈
WinSNMP アプリケーションでは、SnmpCreateSession 関数を使用してアプリケーションが開いたセッションごとに SnmpClose 関数を 1 回呼び出することをお勧めします。 WinSNMP アプリケーションが予期せず終了した場合、実装ですべてのリソースの割り当てを解除できるようにするには、終了する前に SnmpCleanup を呼び出す必要があります。 この実装では、 SnmpCleanup 呼び出しが一連の SnmpClose 呼び出しであるかのように処理され、 SnmpCreateSession の呼び出しの結果として開かれたセッションごとに 1 つの呼び出しが行われます。
実装がセッションを閉じると、セッションの未処理の受信および送信非同期要求と応答がすべて破棄されます。 詳細については、「 WinSNMP セッション」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | winsnmp.h |
| Library | Wsnmp32.lib |
| [DLL] | Wsnmp32.dll |