CIDLData_CreateFromIDArray function (shlobj_core.h)

Article
10/13/2021

[CIDLData_CreateFromIDArray is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions.]

Creates a data object with the default vtable pointer.

Syntax

SHSTDAPI CIDLData_CreateFromIDArray(
  [in]  PCIDLIST_ABSOLUTE        pidlFolder,
  [in]  UINT                     cidl,
  [in]  PCUIDLIST_RELATIVE_ARRAY apidl,
  [out] IDataObject              **ppdtobj
);

Parameters

[in] pidlFolder

Type: PCIDLIST_ABSOLUTE

A fully qualified IDLIST for the root of the items specified in apidl.

[in] cidl

Type: UINT

The number of entries in the apidl array.

[in] apidl

Type: PCUIDLIST_RELATIVE_ARRAY

The array of item IDs relative to pidlFolder. Typically, apidl is an array of child IDs and pidlFolder is a full PIDL for those items. However, pidlFolder can be a null PIDL (desktop IDLISTs). In that case, apidl can contain fully qualified ID lists.

[out] ppdtobj

Type: IDataObject**

The address to a pointer to the object that implements IDataObject.

Return value

Type: HRESULT

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

The data object created by this function offers the Shell clipboard format identifier CFSTR_SHELLIDLIST. This data object also supports IDataObject::SetData calls to pick up other clipboard formats.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	shlobj_core.h (include Shlobj.h)
Library	Shell32.lib
DLL	Shell32.dll (version 5.0 or later)
API set	ext-ms-win-shell-shell32-l1-2-1 (introduced in Windows 10, version 10.0.10240)