Функция LoadCursorA (winuser.h)

Статья
06/21/2023

Загружает указанный ресурс курсора из исполняемого файла (.EXE), связанного с экземпляром приложения.

Примечание

Эта функция заменена функцией LoadImage (с установленными флагами LR_DEFAULTSIZE и LR_SHARED ).

Синтаксис

HCURSOR LoadCursorA(
  [in, optional] HINSTANCE hInstance,
  [in]           LPCSTR    lpCursorName
);

Параметры

[in, optional] hInstance

Тип: HINSTANCE

Дескриптор модуля dll или исполняемого файла (.exe), содержащего курсор для загрузки. Дополнительные сведения см. в разделе GetModuleHandle.

Чтобы загрузить предопределенный системный курсор, задайте для этого параметра значение NULL.

[in] lpCursorName

Тип: LPCTSTR

Если значение hInstance не равно NULL, lpCursorName указывает ресурс курсора по имени или порядковой номеру. Этот порядковый номер должен быть упаковирован с помощью макроса MAKEINTRESOURCE .

Если параметр hInstance имеет значение NULL, lpCursorName указывает идентификатор (начиная с префикса IDC_) предопределенного системного курсора для загрузки.

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

Тип: HCURSOR

Если функция выполняется успешно, возвращаемое значение является дескриптором для вновь загруженного курсора.

Если функция завершается сбоем, возвращается значение NULL. Дополнительные сведения об ошибке можно получить, вызвав GetLastError.

Функция LoadCursor загружает ресурс курсора только в том случае, если он не был загружен; в противном случае он извлекает дескриптор существующего ресурса. Эта функция возвращает допустимый дескриптор курсора, только если параметр lpCursorName является указателем на ресурс курсора. Если lpCursorName является указателем на любой тип ресурса, кроме курсора (например, значок), возвращаемое значение не равно NULL, даже если оно не является допустимым дескриптором курсора.

Функция LoadCursor выполняет поиск ресурса курсора, наиболее подходящего для курсора для текущего устройства отображения. Ресурс курсора может быть цветным или монохромным растровым изображением.

Виртуализация DPI

Этот API не участвует в виртуализации DPI. На возвращаемые выходные данные не влияет разрешение вызывающего потока.

Примеры

Пример см. в разделе Создание курсора.

Примечание

Заголовок winuser.h определяет LoadCursor в качестве псевдонима, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОД. Использование псевдонима, не зависящий от кодирования, с кодом, который не является нейтральным для кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или времени выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.

Требования


Минимальная версия клиента	Windows 2000 Professional [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	winuser.h (включая Windows.h)
Библиотека	User32.lib
DLL	User32.dll