SnmpCancelMsg 関数 (winsnmp.h)
[SNMP は、[要件] セクションで指定したオペレーティング システムで使用できます。 今後のバージョンでは変更されるか、利用できなくなる場合もあります。 代わりに、WS-Man の Microsoft 実装である Windows リモート管理を使用します。
WinSNMP アプリケーションは SnmpCancelMsg 関数を呼び出して、Microsoft WinSNMP 実装で SNMP 要求メッセージの再送信試行とタイムアウト通知を取り消すよう要求します。 SnmpCancelMsg 関数は、WinSNMP API バージョン 2.0 の要素です。
構文
SNMPAPI_STATUS SNMPAPI_CALL SnmpCancelMsg(
[in] HSNMP_SESSION session,
[in] smiINT32 reqId
);
パラメーター
[in] session
取り消される SNMP 要求メッセージ (PDU) を送信した WinSNMP セッションを処理します。
[in] reqId
対象の PDU を識別する一意の数値を指定します。 このパラメーターは、SnmpSendMsg 関数に対するアプリケーションの初期呼び出しで指定された PDU パラメーターの要求 ID (request_id) と一致している必要があります。
戻り値
関数が成功した場合、戻り値はSNMPAPI_SUCCESS。
関数が失敗した場合、戻り値はSNMPAPI_FAILURE。 拡張エラー情報を取得するには、 SnmpGetLastError を呼び出します。 SnmpGetLastError 関数は、次のいずれかのエラーを返すことができます。
| リターン コード | 説明 |
|---|---|
|
セッション パラメーターが無効です。 |
|
reqId パラメーターは、指定されたセッションの未処理のメッセージを識別しません。 |
|
SnmpStartup 関数が正常に完了しませんでした。 |
|
メモリ割り当て中にエラーが発生しました。 |
|
不明または未定義のエラーが発生しました。 |
注釈
SnmpCancelMsg 関数の呼び出しは、再送信モードが SNMPAPI_OFF に等しい特定の SNMP メッセージに対して SnmpSetRetransmitMode 関数を呼び出すことと同じです。
詳細については、「 再送信の取り消し 」および「再送信 ポリシーの管理」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | winsnmp.h |
| Library | Wsnmp32.lib |
| [DLL] | Wsnmp32.dll |