IPropertyDescription::GetDisplayName メソッド (propsys.h)

  • [アーティクル]

任意の UI に表示されるプロパティの表示名を取得します。

構文

HRESULT GetDisplayName(
  [out] LPWSTR *ppszName
);

パラメーター

[out] ppszName

種類: LPWSTR*

null で終わる Unicode 文字列として、プロパティの名前へのポインターのアドレスを格納します。

戻り値

種類: HRESULT

次のいずれかの値を返します。

リターン コード 説明
S_OK
 表示名が取得されます。
E_INVALIDARG
 ppszDisplayName パラメーターは NULL です。
E_OUTOFMEMORY
 メモリの割り当てが失敗しました。

解説

このメソッドによって取得される情報は、プロパティの .propdesc ファイル内の labelInfo 要素の singularLabel 属性と pluralLabel 属性から取得されます。

呼び出し元のアプリケーションは、 CoTaskMemFree を使用して 、ppszDisplayName によって参照される文字列が不要になったときに解放する必要があります。

要件

   
サポートされている最小のクライアント Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2008 [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー propsys.h

関連項目

IPropertyDescription

プロパティの説明スキーマ