SnmpGetLastError 関数 (winsnmp.h)
[SNMP は、[要件] セクションで指定したオペレーティング システムで使用できます。 今後のバージョンでは変更されるか、利用できなくなる場合もあります。 代わりに、WS-Man の Microsoft 実装である Windows リモート管理を使用します。
WinSNMP SnmpGetLastError 関数は、呼び出し元のアプリケーションの最後のエラー コード値を返します。 値は、WinSNMP アプリケーションによって最後に実行された関数呼び出しが失敗した理由を示します。
構文
SNMPAPI_STATUS SNMPAPI_CALL SnmpGetLastError(
[in] HSNMP_SESSION session
);
パラメーター
[in] session
WinSNMP セッションを処理します。 このパラメーターは NULL にすることもできます。
場合によっては、関数呼び出しが失敗したときに 、NULLセッション 値を SnmpGetLastError 関数に渡して、最後のエラー コード値を取得できます。 これは、 セッション パラメーターを含まない関数呼び出しと、 セッション パラメーター値が無効な場合に当てはまります。 これらのケースは、関数の参照ページの [戻り値] セクションに記載されています。
シングルスレッド アプリケーションは、SNMPGetLastError に NULL セッション値を渡して、アプリケーション全体の最後のエラー情報を取得できます。
詳細については、次の「備考」および「戻り値」セクションを参照してください。
戻り値
セッション パラメーターが有効な WinSNMP セッション ハンドルである場合、SnmpGetLastError 関数は、指定されたセッションで発生した最後の WinSNMP エラーを返します。
セッション パラメーターが NULL の場合 (たとえば、SnmpStartup 関数が失敗した場合)、SnmpGetLastError は発生した最後の WinSNMP エラーを返します。
注釈
WinSNMP アプリケーションは、関数が失敗した直後に SnmpGetLastError を呼び出して、最後のエラー コードを取得する必要があります。 別の関数が失敗した場合は、最後に失敗した関数によって設定された最後のエラー コードが上書きされます。 詳細については、「 WinSNMP エラー コード」を参照してください。
セッション パラメーターはマルチスレッドとシングルスレッドの両方の Windows オペレーティング環境に対応しますが、あるスレッドの最後のエラー コードが別のスレッドの最後のエラー コードを上書きする可能性があります。
SnmpGetLastError は、次の条件で WinSNMP アプリケーションに最後のエラー コードを返すことができる必要があることに注意してください。
- SnmpStartup 関数が失敗した後
- SnmpCreateSession 関数がアプリケーションのインスタンスに対して WinSNMP セッションを作成する前
- SnmpClose 関数がアプリケーションのインスタンスのすべての WinSNMP セッションを閉じると
- SnmpCleanup 関数が WinSNMP アプリケーションを Microsoft WinSNMP 実装から切断した後
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | winsnmp.h |
| Library | Wsnmp32.lib |
| [DLL] | Wsnmp32.dll |