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

Статья
11/20/2024

Загружает указанный ресурс курсора из исполняемого файла (.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.

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

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

Тип: HCURSOR

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

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

Замечания

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

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

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

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

Примеры

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

Заметка

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

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows 2000 Профессиональный [только классические приложения]
минимальный поддерживаемый сервер	Windows 2000 Server [только классические приложения]
целевая платформа	Виндоус
заголовка	winuser.h (включая Windows.h)
библиотеки	User32.lib
DLL	User32.dll