Функция DsGetIcon (dsclient.h)

Статья
02/29/2024

Функция DsGetIcon получает значок для заданного класса объектов. Эта функция является устаревшей. Новые приложения должны использовать метод IDsDisplaySpecifier::GetIcon для выполнения этой функции.

Синтаксис

HICON DsGetIcon(
  [in] DWORD   dwFlags,
  [in] LPCWSTR pszObjectClass,
  [in] INT     cxImage,
  [in] INT     cyImage
);

Параметры

[in] dwFlags

Содержит набор флагов, указывающих тип извлекаемого значка. Это может быть сочетание одного или нескольких из следующих значений.

DSGIF_ISNORMAL

Получает обычный значок для класса объекта.

DSGIF_ISOPEN

Получает значок открытия, например открытую папку, для класса объекта. Если у класса объектов нет открытого значка, эта функция пытается получить обычный значок для класса объекта.

DSGIF_ISDISABLED

Получает значок отключенного, например отключенного пользователя, для класса объекта . Если у класса объектов нет отключенного значка, эта функция пытается получить обычный значок для класса объекта.

DSGIF_GETDEFAULTICON

Если значок для класса объекта не найден, эта функция вернет значок по умолчанию. Если этот флаг не указан и не удается найти значок для класса объектов, эта функция возвращает значение NULL.

DSGIF_DEFAULTISCONTAINER

Если значок для класса объекта не найден, эта функция возвращает значок контейнера в качестве значка по умолчанию. Если этот флаг не указан и не удается найти значок для класса объектов, эта функция возвращает значение NULL.

[in] pszObjectClass

Указатель на строку Юникода, завершающуюся значением NULL, которая содержит имя класса объекта, для которого требуется получить значок. Примеры имени класса объекта: user и container.

[in] cxImage

Содержит нужную ширину значка (в пикселях). Эта функция извлекает значок, который наиболее точно соответствует этой ширине.

[in] cyImage

Содержит нужную высоту (в пикселях) значка. Эта функция извлекает значок, который наиболее точно соответствует этой высоте.

Возвращаемое значение

Возвращает дескриптор значка в случае успешного выполнения или значение NULL в противном случае. Вызывающий объект должен уничтожить этот значок, если он больше не требуется, передав этот дескриптор в DestroyIcon.

Требования

Требование	Значение
Минимальная версия клиента	Windows Vista
Минимальная версия сервера	Windows Server 2008
Целевая платформа	Windows
Header	dsclient.h
Библиотека	Dsuiext.lib
DLL	Dsuiext.dll

См. также раздел

DestroyIcon

IDsDisplaySpecifier::GetIcon

Поделиться через