SHGetNameFromIDList 関数 (shobjidl_core.h)

  • [アーティクル]

IDList によって識別される項目の表示名を取得します。

構文

SHSTDAPI SHGetNameFromIDList(
  [in]  PCIDLIST_ABSOLUTE pidl,
  [in]  SIGDN             sigdnName,
  [out] PWSTR             *ppszName
);

パラメーター

[in] pidl

種類: PCIDLIST_ABSOLUTE

項目を識別する PIDL。

[in] sigdnName

種類: SIGDN

取得する表示名の種類を指定する SIGDN 列挙からの値。

[out] ppszName

種類: PWSTR*

この関数が正常に返されるときに、取得した表示名へのポインターのアドレスを受け取る値。

戻り値

型: HRESULT

この関数が成功すると、 S_OKが返されます。 そうでない場合は、HRESULT エラー コードを返します。

注釈

ppszName が指す文字列が不要になったときに解放するのは、呼び出し元の責任です。 *ppszName で CoTaskMemFree を呼び出して、メモリを解放します。

要件

要件 値
サポートされている最小のクライアント Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2008 [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー shobjidl_core.h (Shobjidl.h を含む)
[DLL] Shell32.dll