SnmpStrToEntity 関数 (winsnmp.h)
[SNMP は、[要件] セクションで指定したオペレーティング システムで使用できます。 今後のバージョンでは変更されるか、利用できなくなる場合もあります。 代わりに、WS-Man の Microsoft 実装である Windows リモート管理を使用します。
WinSNMP SnmpStrToEntity 関数は、Microsoft WinSNMP 実装に固有の SNMP 管理エンティティに関する情報へのハンドルを返します。
構文
HSNMP_ENTITY SNMPAPI_CALL SnmpStrToEntity(
[in] HSNMP_SESSION session,
[in] LPCSTR string
);
パラメーター
[in] session
WinSNMP セッションを処理します。
[in] string
対象の SNMP 管理エンティティを識別する null で終わる文字列へのポインター。 エンティティ変換モードとコンテキスト変換モードの現在の設定によって、 SnmpStrToEntity が入力文字列を次のように解釈する方法が決まります。
戻り値
関数が成功した場合、戻り値は対象の SNMP 管理エンティティへのハンドルです。
関数が失敗した場合、戻り値はSNMPAPI_FAILURE。 拡張エラー情報を取得するには、 SnmpGetLastError を呼び出します。 SnmpGetLastError 関数は、次のいずれかのエラーを返すことができます。
| リターン コード | 説明 |
|---|---|
|
SnmpStartup 関数が正常に完了しませんでした。 |
|
メモリ割り当て中にエラーが発生しました。 |
|
セッション パラメーターが無効です。 |
|
エンティティ文字列が無効です。 |
|
不明または未定義のエラーが発生しました。 |
注釈
エンティティとコンテキスト変換モードの現在の設定によって、 SnmpStrToEntity が対象の管理エンティティを識別する入力文字列を解釈する方法が決まります。 詳細については、「 WinSNMP での IPX アドレス文字列のサポート 」および 「エンティティとコンテキスト変換モードの設定」を参照してください。
WinSNMP アプリケーションは SnmpFreeEntity 関数を呼び出して、 SnmpStrToEntity 関数によって割り当てられたエンティティ ハンドルを解放する必要があります。 詳細については、「WinSNMP データ管理の概念」を参照してください。
SnmpStrToEntity 関数は、WinSNMP アプリケーションが複数の WinSNMP 関数で srcEntity または dstEntity パラメーターとして使用できる有効なエンティティ ハンドルを返します。 これらの関数には、 SnmpSendMsg、 SnmpRecvMsg、 SnmpRegister、 SnmpEncodeMsg、 SnmpDecodeMsg 関数が含まれます。
実装は、SnmpStartup 関数の nTranslateMode パラメーターで現在のエンティティとコンテキスト変換モードを返します。 WinSNMP アプリケーションでは、 SnmpSetTranslateMode 関数を呼び出して、エンティティとコンテキスト変換モードの設定を変更できます。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | winsnmp.h |
| Library | Wsnmp32.lib |
| [DLL] | Wsnmp32.dll |