SnmpMgrOpen 関数 (mgmtapi.h)
[SNMP は、[要件] セクションで指定したオペレーティング システムで使用できます。 今後のバージョンでは変更されるか、利用できなくなる場合もあります。 代わりに、WS-Man の Microsoft 実装である Windows リモート管理を使用します。
SnmpMgrOpen 関数は、通信ソケットとデータ構造を初期化し、指定された SNMP エージェントとの通信を可能にします。 この関数は、SNMP Management API の要素です。
構文
LPSNMP_MGR_SESSION SNMP_FUNC_TYPE SnmpMgrOpen(
[in] LPSTR lpAgentAddress,
[in] LPSTR lpAgentCommunity,
[in] INT nTimeOut,
[in] INT nRetries
);
パラメーター
[in] lpAgentAddress
ホスト名または IP アドレスを指定する null で終わる文字列へのポインター。 ホスト名は、IP アドレス、IPX アドレス (8.12 表記)、またはイーサネット アドレスに解決する必要があります。 ホスト名と IP アドレスに使用できるフォームについては、「解説」セクションを参照してください。
[in] lpAgentCommunity
lpAgentAddress パラメーターで識別されるエージェントと通信するときに使用する SNMP コミュニティ名を指定する null で終わる文字列へのポインター。
[in] nTimeOut
通信のタイムアウトをミリ秒単位で指定します。
[in] nRetries
通信の再試行回数を指定します。 nTimeOut パラメーターで指定されたタイムアウトは、再試行が送信されるたびに 2 倍になります。
戻り値
関数が成功した場合、戻り値は LPSNMP_MGR_SESSION 構造体へのポインターです。 この構造は内部的に使用され、プログラマはそれを変更しないでください。 詳細については、「解説」を参照してください。
関数が失敗した場合は、返される値は NULL です。 詳細なエラー情報を得るには、GetLastError を呼び出します。 GetLastError は 、メモリ割り当てエラーを示すSNMP_MEM_ALLOC_ERRORエラー コードを返す場合があります。
この関数は、Windows ソケットのエラー コードを返す場合もあります。
注釈
可能であれば、ホスト名を使用して 、lpAgentAddress パラメーター内の SNMP エージェントを識別します。 ホスト名は、TCP/IP が読み込まれ、名前が TCP/IP ホスト名である場合にのみ、エージェントに対して指定できます。 IPX ホストには NetBIOS 名を指定できません。
SNMP ターゲットの名前とアドレス、または lpAgentAddress パラメーターが指す文字列は、次のいずれかの形式に準拠している必要があります。
| 名前/アドレス | フォーム (例) |
|---|---|
| ホスト名 | merlin または merlin.microsoft.com |
| [IPv4 アドレス] | 157.57.8.160 |
| [IPv6 アドレス] | 3ffe:8311:ffff::b3ff:fe88:c33 |
| MAC アドレス | 00aa00bbccdd |
| IPX アドレス | 00006112.00aa00bbccdd |
アプリケーションでは、 別のスレッド のコンテキストで SnmpMgrRequest 関数を呼び出すために、この関数によって返されるLPSNMP_MGR_SESSION ポインターを使用しないでください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | mgmtapi.h |
| Library | Mgmtapi.lib |
| [DLL] | Mgmtapi.dll |