SHGetDataFromIDListSHGetDataFromIDList*
*Contents  *Index  *Topic Contents
*Previous Topic: SHFreeNameMappings
*Next Topic: SHGetDesktopFolder

SHGetDataFromIDList


HRESULT ShGetDataFromIDList(
    LPSHELLFOLDER psf,
    LPCITEMIDLIST pidl,
    int nFormat,
    PVOID pv,
    int cb
);

Retrieves extended property data from a relative identifier list.

psf
Address of the parent IShellFolder interface.
pidl
Address of an ITEMIDLIST structure that identifies the subfolder relative to the folder specified in psf.
nFormat
Specifies the format in which the data is being requested. This must be one of the following formats:
SHGDFIL_FINDDATA Format used for file system objects. The pv parameter is the address of a WIN32_FIND_DATA structure.
SHGDFIL_NETRESOURCE Format used for network resources. The pv parameter is the address of a NETRESOURCE structure.
SHGDFIL_DESCRIPTIONID Format used for network resources. The pv parameter is the address of an SHDESCRIPTIONID structure.
pv
Address of a buffer that receives the requested data. The format of this buffer is determined by nFormat.

If nFormat is SHGDFIL_NETRESOURCE, there are two possible cases. If the buffer is large enough, the net resource's string information (fields for the network name, local name, provider, and comments) will be placed into the buffer. If the buffer is not large enough, only the net resource structure will be placed into the buffer and the string information pointers will be NULL.

cb
Size of the buffer at pv, in bytes.

E_INVALIDARG is returned if the psf, pidl, pv, or cb parameters do not match the nFormat parameter, or if nFormat is not one of the specific SHGDFIL_ values shown above.

Up Top of Page
© 1997 Microsoft Corporation. All rights reserved. Terms of Use.