SnmpExtensionInit 関数 (snmp.h)

[アーティクル]
03/02/2024

[SNMP は、[要件] セクションで指定したオペレーティングシステムで使用できます。今後のバージョンでは変更されるか、利用できなくなる場合もあります。代わりに、WS-Man の Microsoft 実装である Windows リモート管理を使用します。

Microsoft SNMP サービスは SnmpExtensionInit 関数を呼び出して、SNMP 拡張エージェント DLL を初期化します。この関数は、SNMP 拡張エージェント API の要素です。

構文

BOOL SNMP_FUNC_TYPE SnmpExtensionInit(
  [in]  DWORD               dwUptimeReference,
  [out] HANDLE              *phSubagentTrapEvent,
  [out] AsnObjectIdentifier *pFirstSupportedRegion
);

パラメーター

[in] dwUptimeReference

拡張エージェントのタイムゼロ参照を指定します。

メモ拡張機能エージェントは、このパラメーターを無視する必要があります。 SNMP 拡張エージェント DLL では、 SnmpSvcGetUptime 関数を使用して、SNMP サービスが実行されている秒数を取得する必要があります。詳細については、「解説」を参照してください。

[out] phSubagentTrapEvent

拡張エージェントが SNMP サービスに渡すイベントハンドルへのポインター。このハンドルは、拡張エージェントに送信する 1 つ以上のトラップがあることをサービスに通知するために使用されます。イベントハンドルの割り当てと割り当て解除の詳細については、次の「解説」セクションを参照してください。

[out] pFirstSupportedRegion

拡張エージェントがサポートする最初の MIB サブツリーを受け取る AsnObjectIdentifier 構造体へのポインター。この構造体のリソースの割り当てと割り当て解除の詳細については、次の「解説」セクションを参照してください。

拡張エージェントは、 SnmpExtensionInitEx エントリポイント関数を実装することで、追加の MIB サブツリーを登録できます。

戻り値

関数が成功した場合、戻り値は TRUE になります。

関数が失敗した場合、戻り値は FALSE になります。

注釈

拡張エージェントは dwUptimeReference パラメーターを無視する必要があります。代わりに、 SnmpSvcGetUptime 関数を呼び出して、Microsoft SNMP サービスが実行されている秒数を取得する必要があります。 dwUptimeReference パラメーターは経過時間を DWORD 値としてミリ秒単位で格納するため、時間が 0 に折り返され、不正確な時間間隔が反映される可能性があります。

拡張エージェントは、 phSubagentTrapEvent パラメーターで渡されたイベントハンドルをシグナル状態に設定することで、1 つ以上のトラップを送信する必要があることを SNMP サービスに通知します。このイベントが通知された後、SNMP サービスは、関数が FALSE の値を返すまで、拡張エージェントの SnmpExtensionTrap エントリポイントを繰り返し呼び出します。これは、拡張エージェントに送信するトラップがないことを示します。拡張エージェントがトラップを生成しない場合、 phSubagentTrapEvent パラメーターは NULL の値を返す必要があります。

SNMP 拡張エージェントは、トラップイベントハンドルのリソースを割り当ておよび割り当て解除する必要があります。 SNMP サービスが SnmpExtensionInit 関数を呼び出すとき、拡張エージェントは CreateEvent 関数を呼び出してイベントハンドルを割り当てる必要があります。拡張エージェントは、 phSubagentTrapEvent パラメーターで SNMP サービスにハンドルを渡します。 SNMP サービスが SnmpExtensionClose 関数を呼び出すとき、拡張エージェントはトラップイベントハンドルのリソースの割り当てを解除する必要があります。

SNMP サービスは、拡張エージェントが pFirstSupportedRegion パラメーターで返す AsnObjectIdentifier 構造体のコピーを作成します。拡張エージェントは、元の構造に関連付けられているリソースを割り当てて割り当てを解除する必要があります。これは、SNMP サービスが SnmpExtensionClose 関数を呼び出すときに実行できます。

要件

要件	値
サポートされている最小のクライアント	Windows 2000 Professional [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	snmp.h