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

  • [アーティクル]

現在の並べ替え順序を記述するローカライズされた表示文字列を取得します。

構文

HRESULT GetSortDescriptionLabel(
  [in]  BOOL   fDescending,
  [out] LPWSTR *ppszDescription
);

パラメーター

[in] fDescending

種類: BOOL*

ppszDescription が文字列 "Z on top" を参照する必要がある場合は TRUE。文字列 "A on top" を参照する場合は FALSE。

[out] ppszDescription

種類: LPWSTR*

このメソッドが戻るとき、 には、null で終わる Unicode 文字列として並べ替えの説明へのポインターのアドレスが含まれます。

戻り値

種類: HRESULT

このメソッドは、成功すると S_OK を返します。 そうでない場合は、HRESULT エラー コードを返します。

注釈

このメソッドによって取得される文字列は、プロパティの .propdesc ファイルの labelInfo 要素の sortDescription 属性に設定されたフラグによって決まります。

ppszDescription が不要になったら、呼び出し元のアプリケーションが解放する必要があります。

要件

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

こちらもご覧ください

IPropertyDescription

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