SnmpEntityToStr 関数 (winsnmp.h)
[SNMP は、[要件] セクションで指定されたオペレーティング システムで使用できます。 今後のバージョンでは変更されるか、利用できなくなる場合もあります。 代わりに、WS-Man の Microsoft 実装である Windows リモート管理を使用します。
WinSNMP SnmpEntityToStr 関数は、SNMP 管理エンティティを識別する文字列を返します。
構文
SNMPAPI_STATUS SNMPAPI_CALL SnmpEntityToStr(
[in] HSNMP_ENTITY entity,
[in] smiUINT32 size,
[out] LPSTR string
);
パラメーター
[in] entity
目的の SNMP 管理エンティティを処理します。
[in] size
文字列パラメーターが指すバッファーのサイズをバイト単位で指定します。 WinSNMP アプリケーションは、出力文字列を格納するのに十分な大きさのバッファーを割り当てる必要があります。
[out] string
目的の SNMP 管理エンティティを識別する null で終わる文字列を受け取るバッファーへのポインター。
戻り値
関数が成功した場合、戻り値は、 SnmpEntityToStr が 文字列 バッファーで返す終端の null バイトを含むバイト数です。 この値は size パラメーターの値以下にできますが、大きくすることはできません。
関数が失敗した場合、戻り値はSNMPAPI_FAILURE。 拡張エラー情報を取得するには、 SnmpGetLastError を呼び出します。 SnmpGetLastError 関数は、次のいずれかのエラーを返すことができます。
| リターン コード | 説明 |
|---|---|
|
SnmpStartup 関数が正常に完了しませんでした。 |
|
メモリ割り当て中にエラーが発生しました。 |
|
エンティティ パラメーターが無効です。 |
|
出力バッファーの長さが不十分です。 |
|
不明または未定義のエラーが発生しました。 |
注釈
エンティティ変換モードとコンテキスト変換モードの現在の設定によって、 SnmpEntityToStr が返す出力文字列の種類が決まります。 詳細については、「 WinSNMP での IPX アドレス文字列のサポート 」および 「エンティティおよびコンテキスト変換モードの設定」を参照してください。
エンティティとコンテキスト変換モードがSNMPAPI_TRANSLATEDされ、エントリが実装のデータベースに存在する場合、実装は管理エンティティの関連付けられたユーザー フレンドリ名を返します。 管理エンティティのエントリが存在しない場合、 SnmpEntityToStr は 管理エンティティのリテラル SNMP トランスポート アドレスを返します。
エンティティとコンテキスト変換モードがSNMPAPI_UNTRANSLATED_V1またはSNMPAPI_UNTRANSLATED_V2場合、Microsoft WinSNMP 実装では、管理エンティティのリテラル SNMP トランスポート アドレスも返されます。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | winsnmp.h |
| Library | Wsnmp32.lib |
| [DLL] | Wsnmp32.dll |