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