Edit

Share via

IShellIconOverlayIdentifier::IsMemberOf method (shobjidl_core.h)

  • Article

Specifies whether an icon overlay should be added to a Shell object's icon.

Syntax

HRESULT IsMemberOf(
  [in] LPCWSTR pwszPath,
       DWORD   dwAttrib
);

Parameters

[in] pwszPath

Type: PCWSTR

A Unicode string that contains the fully qualified path of the Shell object.

dwAttrib

Type: DWORD

The object's attributes. For a complete list of file attributes and their associated flags, see File Attribute Constants.

Return value

Type: HRESULT

This method returns one of the following:

Return code Description
S_OK
 The icon overlay should be displayed.
S_FALSE
 The icon overlay should not be displayed.
E_FAIL
 The operation failed.

Remarks

The Shell calls this method to determine whether it should display a handler's icon overlay for a particular object. Icon overlay handlers are usually intended to work with a particular group of files. A typical example is a file type, identified by a specific file name extension. An icon overlay handler might request an icon overlay for all members of the file type. Some handlers request an icon overlay only if a member of the file type is in a particular state. However, icon overlay handlers are free to request their icon overlay for any object that they want.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional, Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header shobjidl_core.h (include Shlobj.h)
DLL Shell32.dll (version 5.0 or later)

See also

IShellIconOverlayIdentifier