SHGetDataFromIDListW 関数 (shlobj_core.h)

[アーティクル]
11/20/2024

相対識別子リストから拡張プロパティデータを取得します。

構文

SHSTDAPI SHGetDataFromIDListW(
  [in]  IShellFolder    *psf,
  [in]  PCUITEMID_CHILD pidl,
        int             nFormat,
  [out] void            *pv,
        int             cb
);

パラメーター

[in] psf

型: IShellFolder*

IShellFolder インターフェイス親のアドレス。これは、pidl パラメーターによって参照される ITEMIDLIST 構造体の直接の親である必要があります。

[in] pidl

型: PCUITEMID_CHILD

psfで指定されたフォルダーに対する相対オブジェクトを識別する、ITEMIDLIST 構造体ポインター。

nFormat

型: int

データが要求される形式。このパラメーターは、次のいずれかの値に設定する必要があります。

SHGDFIL_FINDDATA

ファイルシステムオブジェクトに使用される形式。 pv パラメーターは、WIN32_FIND_DATA 構造体のアドレスです。

SHGDFIL_NETRESOURCE

ネットワークリソースに使用される形式。 pv パラメーターは、NETRESOURCE 構造体のアドレスです。

SHGDFIL_DESCRIPTIONID

バージョン 4.71。ネットワークリソースに使用される形式。 pv パラメーターは、SHDESCRIPTIONID 構造体のアドレスです。

[out] pv

型: void*

この関数が正常に返されると、要求されたデータを受け取るバッファーへのポインター。このバッファーの形式は、nFormatによって決まります。

nFormat SHGDFIL_NETRESOURCE場合は、2 つのケースが考えられます。バッファーが十分な大きさの場合、ネットリソースの文字列情報 (ネットワーク名、ローカル名、プロバイダー、およびコメントのフィールド) がバッファーに配置されます。バッファーが十分な大きさでない場合は、net リソース構造のみがバッファーに配置され、文字列情報ポインターは NULLされます。

cb

型: int

pvのバッファーのサイズ (バイト単位)。

戻り値

型: HRESULT

成功した場合はS_OKを返し、それ以外の場合はE_INVALIDARG返します。

備考

この関数は、項目識別子リスト (PIDL) へのポインターに存在する情報のみを抽出します。 PIDL の内容は PIDL を作成したフォルダーオブジェクトに依存するため、要求されたすべての情報が使用できる保証はありません。さらに、返される情報には、PIDL が作成された時点のオブジェクトの状態が反映されます。オブジェクトの現在の状態は異なる場合があります。たとえば、nFormat を SHGDFIL_FINDDATAに設定すると、関数は WIN32_FIND_DATA 構造体の一部のメンバーにのみ意味のある値を割り当てることができます。残りのメンバーは 0 に設定されます。ファイルシステムファイルまたはフォルダーの完全な現在の情報を取得するには、GetFileTime や FindFirstFileなどの標準ファイルシステム関数を使用します。

E_INVALIDARGは、psf、pidl、pv、または cb パラメーターが nFormat パラメーターと一致しない場合、または nFormat が上記の特定のSHGDFIL_値の 1 つでない場合返されます。

手記

shlobj_core.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして SHGetDataFromIDList を定義します。エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイムエラーが発生する不一致が発生する可能性があります。詳細については、「関数プロトタイプの規則」を参照してください。

必要条件

要件	価値
サポートされる最小クライアント	Windows XP [デスクトップアプリのみ]
サポートされる最小サーバー	Windows 2000 Server [デスクトップアプリのみ]
ターゲットプラットフォームの	ウィンドウズ
ヘッダー	shlobj_core.h (Shlobj.h、Shlobj_core.h を含む)
ライブラリ	Shell32.lib
DLL	Shell32.dll (バージョン 4.0 以降)
API セットの	ext-ms-win-shell-shell32-l1-2-1 (Windows 10 バージョン 10.0.10240 で導入)

次の方法で共有