SnmpFreeEntity 関数 (winsnmp.h)
[SNMP は、[要件] セクションで指定されたオペレーティング システムで使用できます。 今後のバージョンでは変更されるか、利用できなくなる場合もあります。 代わりに、WS-Man の Microsoft 実装である Windows リモート管理を使用します。
WinSNMP SnmpFreeEntity 関数は、SNMP 管理エンティティに関連付けられているリソースを解放します。
構文
SNMPAPI_STATUS SNMPAPI_CALL SnmpFreeEntity(
[in] HSNMP_ENTITY entity
);
パラメーター
[in] entity
リソースが解放される SNMP 管理エンティティを処理します。
戻り値
関数が成功した場合、戻り値はSNMPAPI_SUCCESS。
関数が失敗した場合、戻り値はSNMPAPI_FAILURE。 拡張エラー情報を取得するには、セッション パラメーターに NULL 値を指定して SnmpGetLastError を呼び出します。 SnmpGetLastError 関数は、次のいずれかのエラーを返すことができます。
| リターン コード | 説明 |
|---|---|
|
SnmpStartup 関数が正常に完了しませんでした。 |
|
メモリ割り当て中にエラーが発生しました。 |
|
エンティティ パラメーターが無効です。 |
|
不明または未定義のエラーが発生しました。 |
注釈
WinSNMP アプリケーションが SnmpClose 関数または SnmpCleanup 関数を呼び出すと、Microsoft WinSNMP 実装は、WinSNMP セッションに割り当てられたすべてのリソースを解放します。 ただし、WinSNMP アプリケーションでは、リソースに対応する WinSNMP 関数を使用して個々のリソースを解放することをお勧めします。 たとえば、アプリケーションは SnmpFreeEntity 関数を呼び出して、 SnmpStrToEntity 関数の呼び出しによって割り当てられたリソースを解放する必要があります。 これにより、実装の作業負荷が軽減され、実装のサービスをすべてのアプリケーションに拡張する必要があります。
詳細については、「WinSNMP データ管理の概念」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | winsnmp.h |
| Library | Wsnmp32.lib |
| [DLL] | Wsnmp32.dll |