IUPnPDevice::get_Description メソッド (upnp.h)
Description プロパティは、デバイスの機能の人間が判読できる概要を指定します。
構文
HRESULT get_Description(
[out] BSTR *pbstr
);
パラメーター
[out] pbstr
この種類のデバイスの目的の機能の簡単な説明を含む文字列への参照を受け取ります。 不要になったら、 SysFreeString を 使用してこの文字列を解放します。 デバイスで説明が指定されていない場合、このパラメーターは NULL に設定されます。
戻り値
C++ の場合: このプロパティの "get" メソッドが成功した場合、戻り値はS_OK。 デバイスでこの URL が指定されていない場合、戻り値はS_FALSE、 pbstr は NULL です。 それ以外の場合、メソッドは WinError.h で定義されている COM エラー コードのいずれかを返します。
解説
このプロパティは省略可能であり、 pbstr は NULL を返すことができます。
要件
| サポートされている最小のクライアント | Windows XP (デスクトップ アプリのみ) |
| サポートされている最小のサーバー | サポートなし |
| 対象プラットフォーム | Windows |
| ヘッダー | upnp.h |
| [DLL] | Upnp.dll |