Export (0) Print
Expand All
Expand Minimize
0 out of 1 rated this helpful - Rate this topic

SHMapPIDLToSystemImageListIndex function

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

Retrieves the icon index from the system image list that is associated with a folder item.

Syntax


int SHMapPIDLToSystemImageListIndex(
  _In_       IShellFolder *psf,
  _In_       PCUITEMID_CHILD pidl,
  _Out_opt_  int *piIndex
);

Parameters

psf [in]

Type: IShellFolder*

An IShellFolder interface pointer for the folder that contains the item.

pidl [in]

Type: PCUITEMID_CHILD

A pointer to the item's ITEMIDLIST structure.

piIndex [out, optional]

Type: int*

A pointer to an int that, when this function returns successfully, receives the index of the item's open icon in the system image list. If the item does not have a special open icon then the index of its normal icon is returned. If the open icon exists and cannot be obtained, then the value pointed to by piIndex is set to -1. This parameter can be NULL if the calling application is not interested in the open icon.

Return value

Type: int

Returns the index of the item's normal icon in the system image list if successful, or -1 otherwise.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

End of client support

Windows XP with SP2

End of server support

Windows Server 2003

Header

Shlobj.h

Library

Shell32.lib

DLL

Shell32.dll (version 5.0 or later)

 

 

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

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.