SnmpSetVb 関数 (winsnmp.h)
[SNMP は、[要件] セクションで指定されたオペレーティング システムで使用できます。 今後のバージョンでは変更されるか、利用できなくなる場合もあります。 代わりに、WS-Man の Microsoft 実装である Windows リモート管理を使用します。
WinSNMP SnmpSetVb 関数は、変数バインド リスト内の変数バインド エントリを変更します。 また、この関数は、既存の変数バインド リストに新しい変数バインド エントリを追加します。
構文
SNMPAPI_STATUS SNMPAPI_CALL SnmpSetVb(
[in] HSNMP_VBL vbl,
[in] smiUINT32 index,
[in] smiLPCOID name,
[in] smiLPCVALUE value
);
パラメーター
[in] vbl
更新する変数バインド の一覧を処理します。
[in] index
変数バインド リスト内の変数バインド エントリの位置を含む符号なし long 整数変数を指定します (これが更新操作の場合)。 これが追加操作の場合、このパラメーターは 0 に等しい必要があります。 詳細については、「解説」を参照してください。
[in] name
追加または変更する変数の名前を表す smiOID 構造体へのポインター。 詳細については、「解説」を参照してください。
[in] value
smiVALUE 構造体へのポインター。 構造体には、 name パラメーターで指定された変数に関連付けられている値が含まれています。
戻り値
関数が成功した場合、戻り値は、変数バインド リスト内の更新または追加された変数バインド エントリの位置です。 詳細については、次の「解説」セクションを参照してください。
関数が失敗した場合、戻り値はSNMPAPI_FAILURE。 拡張エラー情報を取得するには、 SnmpGetLastError を呼び出します。 SnmpGetLastError 関数は、次のいずれかのエラーを返すことができます。
| リターン コード | 説明 |
|---|---|
|
SnmpStartup 関数が正常に完了しませんでした。 |
|
メモリ割り当て中にエラーが発生しました。 |
|
vbl パラメーターが無効です。 |
|
index パラメーターが無効です。 |
|
name パラメーターが無効です。 |
|
value パラメーターが指す構造体の構文メンバーが無効です。 |
|
不明または未定義のエラーが発生しました。 |
解説
インデックス パラメーターの有効な値の範囲は、0 から n です。 値 0 は、追加操作を示します。 値 n は、変数バインド リスト内の変数バインド エントリの合計数です。 WinSNMP アプリケーションは 、SnmpSetVb を呼び出して変数バインディング エントリの合計数を取得する前に 、SnmpCountVbl 関数を呼び出す必要があります。
関数が更新操作を正常に実行した場合、戻り値は index パラメーターの値と等しくなります。 関数が変数バインド エントリを追加する場合、戻り値は n + 1 です。
name パラメーターが NULL ではなく、値パラメーターが NULL の場合、Microsoft WinSNMP 実装では、値メンバーが NULL に設定され、構文メンバーが SNMP_SYNTAX_ に設定された新しい変数バインド エントリが初期化されます。
index パラメーターが 0 に等しくなく、name パラメーターが NULL の場合、Microsoft WinSNMP 実装では、index パラメーターが指す変数の値のみが更新されます。
要件
| サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | winsnmp.h |
| Library | Wsnmp32.lib |
| [DLL] | Wsnmp32.dll |