SnmpSetRetry 関数 (winsnmp.h)
[SNMP は、[要件] セクションで指定されたオペレーティング システムで使用できます。 今後のバージョンでは変更されるか、利用できなくなる場合もあります。 代わりに、WS-Man の Microsoft 実装である Windows リモート管理を使用します。
WinSNMP SnmpSetRetry 関数を使用すると、WinSNMP アプリケーションで SNMP メッセージ要求の再送信の再試行回数の値を変更できます。 再試行回数は、WinSNMP アプリケーションが、指定された管理エンティティの SnmpSendMsg 関数に対して行う呼び出しに適用されます。 Microsoft WinSNMP 実装では、値がデータベースに格納されます。
構文
SNMPAPI_STATUS SNMPAPI_CALL SnmpSetRetry(
[in] HSNMP_ENTITY hEntity,
[in] smiUINT32 nPolicyRetry
);
パラメーター
[in] hEntity
対象の宛先管理エンティティを処理します。
[in] nPolicyRetry
管理エンティティの再試行回数の新しい値を指定します。 この値は、実装のデータベースに現在格納されている値を置き換えます。
このパラメーターが 0 に等しく、現在の再送信モードが SNMPAPI_ON と等しい場合、実装は再試行回数の値を選択します。 実装では、WinSNMP アプリケーションの再送信ポリシーを実行するときに、この値を使用します。
戻り値
関数が成功した場合、戻り値はSNMPAPI_SUCCESS。
関数が失敗した場合、戻り値はSNMPAPI_FAILURE。 拡張エラー情報を取得するには、セッション パラメーターに NULL 値を指定して SnmpGetLastError を呼び出します。 SnmpGetLastError 関数は、次のいずれかのエラーを返すことができます。
| リターン コード | 説明 |
|---|---|
|
SnmpStartup 関数が正常に完了しませんでした。 |
|
メモリ割り当て中にエラーが発生しました。 |
|
hEntity パラメーターが無効です。 |
|
不明または未定義のエラーが発生しました。 |
注釈
通常、エージェント アプリケーションではなく WinSNMP マネージャー アプリケーションは 、SnmpSetRetry 関数を呼び出します。
詳細については、「 再送信 について」および「 再送信ポリシーの管理」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | winsnmp.h |
| Library | Wsnmp32.lib |
| [DLL] | Wsnmp32.dll |