Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

CIDLData_CreateFromIDArray function

[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


HRESULT CIDLData_CreateFromIDArray(
  _In_   PCIDLIST_ABSOLUTE pidlFolder,
  _In_   UINT cidl,
  _In_   PCUIDLIST_RELATIVE_ARRAY apidl,
  _Out_  IDataObject **ppdtobj
);

Parameters

pidlFolder [in]

Type: PCIDLIST_ABSOLUTE

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

cidl [in]

Type: UINT

The number of entries in the apidl array.

apidl [in]

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.

ppdtobj [out]

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

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

End of client support

Windows Vista

End of server support

Windows Server 2008

Header

Shlobj.h

Library

Shell32.lib

DLL

Shell32.dll (version 5.0 or later)

See also

SHCreateDataObject

 

 

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.