SnmpMgrTrapListen 関数 (mgmtapi.h)
[SNMP は、[要件] セクションで指定したオペレーティング システムで使用できます。 今後のバージョンでは変更されるか、利用できなくなる場合もあります。 代わりに、WS-Man の Microsoft 実装である Windows リモート管理を使用します。
SnmpMgrTrapListen 関数は、SNMP トラップ サービスから SNMP トラップを受信する SNMP マネージャー アプリケーションの機能を登録します。 この関数は、SNMP Management API の要素です。
構文
BOOL SNMP_FUNC_TYPE SnmpMgrTrapListen(
[out] HANDLE *phTrapAvailable
);
パラメーター
[out] phTrapAvailable
使用可能なトラップがあり、アプリケーションが SnmpMgrGetTrap 関数を呼び出す必要があることを示す情報を受け取るイベント ハンドルへのポインター。
戻り値
関数が成功すると、戻り値は 0 以外になります。
関数が失敗した場合は、0 を返します。 拡張エラー情報を取得するには、 GetLastError を呼び出します。GetLastError は、次のいずれかのエラー コードを返す場合があります。
| リターン コード | 説明 |
|---|---|
|
メモリ割り当てエラーを示します。 |
|
この関数が既に呼び出されていることを示します。 |
|
1 つ以上のエラーが発生したことを示します。トラップにアクセスできません。 アプリケーションは、関数の呼び出しを再試行できます。 |
この関数は、他のシステム エラーも返す場合があります。
注釈
管理者ではないユーザーの場合、 SnmpMgrTrapListen 関数は SNMP トラップ サービスが開始されている場合にのみ成功します。
アプリケーションでは、 SnmpMgrGetTrap 関数を呼び出す前に、 必ず SnmpMgrTrapListen 関数を呼び出す必要があります。 これは、 phTrapAvailable パラメーターによって指されるイベント ハンドルによって、SNMP トラップのイベント 駆動型の取得が可能になるためです。 SNMP トラップ サービスがトラップを配信すると、SNMP Management API によってアプリケーションのイベントが通知されます。
また、アプリケーションは SnmpMgrGetTrap 関数をポーリングして、一定の間隔でトラップを検出することもできます。 この場合、アプリケーションは、関数が 0 を返すまで SnmpMgrGetTrap を繰り返し呼び出す必要があります。
Windows Server 2003: SNMP マネージャー アプリケーションは、SNMPMgrClose を NULL セッション パラメーターと共に呼び出して、SnmpMgrTrapListen 関数の正常な呼び出しに関連付けられているリソースをクリーンできます。 ただし、アプリケーションが DLL の場合は、DllMain エントリ ポイント関数から SnmpMgrClose を呼び出さないでください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | mgmtapi.h |
| Library | Mgmtapi.lib |
| [DLL] | Mgmtapi.dll |