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