SnmpGetVb 関数 (winsnmp.h)
[SNMP は、[要件] セクションで指定したオペレーティング システムで使用できます。 今後のバージョンでは変更されるか、利用できなくなる場合もあります。 代わりに、WS-Man の Microsoft 実装である Windows リモート管理を使用します。
WinSNMP アプリケーションは SnmpGetVb 関数を呼び出して、変数バインディング リストから情報を取得します。 この WinSNMP 関数は、 index パラメーターで指定された変数バインド エントリから変数名とその関連値を取得します。
構文
SNMPAPI_STATUS SNMPAPI_CALL SnmpGetVb(
[in] HSNMP_VBL vbl,
[in] smiUINT32 index,
[out] smiLPOID name,
[out] smiLPVALUE value
);
パラメーター
[in] vbl
取得する変数バインド リストを処理します。
[in] index
取得する変数バインド エントリを識別する符号なし long 整数変数を指定します。 この変数には、変数バインド リスト内の変数バインド エントリの位置が含まれます。
このパラメーターの有効な値は 1 から n の範囲です。1 は変数バインド リストの最初の変数バインド エントリを示し、n はリスト内のエントリの合計数です。 詳細については、次の「備考」セクションを参照してください。
[out] name
変数バインド エントリの変数名を受け取る smiOID 構造体へのポインター。
[out] value
name パラメーターで識別される変数に関連付けられた値を受け取る smiVALUE 構造体へのポインター。
関数が成功した場合、value パラメーターが指す構造体の構文メンバーには、次のいずれかの構文データ型を指定できます。 詳細については、RFC 1902「Simple Network Management Protocol (SNMPv2) のバージョン 2 の管理情報の構造」を参照してください。
戻り値
関数が成功した場合、戻り値はSNMPAPI_SUCCESS。
関数が失敗した場合、戻り値はSNMPAPI_FAILURE。 拡張エラー情報を取得するには、 SnmpGetLastError を呼び出します。 SnmpGetLastError 関数は、次のいずれかのエラーを返すことができます。
| リターン コード | 説明 |
|---|---|
|
SnmpStartup 関数が正常に完了しませんでした。 |
|
メモリ割り当て中にエラーが発生しました。 |
|
index パラメーターが無効です。 |
|
vbl パラメーターが無効です。 |
|
不明または未定義のエラーが発生しました。 |
解説
最後の 3 つの構文の種類では、SNMP バージョン 2C (SNMPv2C) フレームワークでの例外条件について説明します。
SnmpGetVb 関数は、name パラメーターが指す構造体の変数バインド エントリの変数名を返します。 value パラメーターによって指される構造体内の変数の関連付けられた 値 を返します。
入力時に、SnmpGetVb 関数は、それぞれ名前パラメーターと値パラメーターによって指される smiOID 構造体と smiVALUE 構造体のメンバーを無視します。 関数が正常に完了すると、Microsoft WinSNMP 実装によってメンバーが上書きされます。
インデックス パラメーターに使用する WinSNMP アプリケーションの有効な値は次のとおりです。
- SnmpCountVbl 関数の呼び出しからの戻り値
- SnmpRecvMsg 関数の呼び出しによって返されるSNMP_PDU_RESPONSE プロトコル・データ・ユニット (PDU) のエラー索引フィールド
要件
| サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | winsnmp.h |
| Library | Wsnmp32.lib |
| [DLL] | Wsnmp32.dll |