Directory Services

DsGetIcon

The DsGetIcon function obtains the icon for a given object class. This function is obsolete. New applications should use the IDsDisplaySpecifier::GetIcon method to perform this function.

HICON DsGetIcon(
  DWORD dwFlags,
  LPWSTR pszObjectClass,
  INT cxImage,
  INT cyImage
);

Parameters

dwFlags
[in] Contains a set of flags that indicate the type of icon to retrieve. This can be a combination of one or more of the following values.
Value Meaning
DSGIF_ISNORMAL Obtains the normal icon for the object class.
DSGIF_ISOPEN Obtains the open icon, such as an open folder, for the object class. If the object class does not have an open icon, this function attempts to obtain the normal icon for the object class.
DSGIF_ISDISABLED Obtains the disabled icon, such as a disabled user, for the object class. If the object class does not have a disabled icon, this function attempts to obtain the normal icon for the object class.
DSGIF_GETDEFAULTICON If no icon can be found for the object class, this function will return a default icon. If this flag is not specified and no icon can be found for the object class, this function returns NULL.
DSGIF_DEFAULTISCONTAINER If no icon can be found for the object class, this function returns the container icon as the default icon. If this flag is not specified and no icon can be found for the object class, this function returns NULL.
pszObjectClass
[in] Pointer to a null-terminated Unicode string that contains the name of the object class to retrieve the icon for. Examples of the object class name are "user" and "container".
cxImage
[in] Contains the desired width, in pixels, of the icon. This function retrieves the icon that most closely matches this width.
cyImage
[in] Contains the desired height, in pixels, of the icon. This function retrieves the icon that most closely matches this height.

Return Values

Returns a handle to the icon if successful or NULL otherwise. The caller must destroy this icon when it is no longer required by passing this handle to DestroyIcon.

Requirements

Client: Included in Windows XP and Windows 2000 Professional.
Server: Included in Windows Server 2003 and Windows 2000 Server.
Redistributable: Requires Active Directory Client Extension on Windows NT 4.0 SP6a and Windows 95/98/Me.
Header: Declared in Dsclient.h.
Library: Use Dsuiext.lib.

See Also

IDsDisplaySpecifier::GetIcon, DestroyIcon