Função LoadCursorA (winuser.h)

Artigo
08/27/2023

Carrega o recurso de cursor especificado do arquivo executável (.EXE) associado a uma instância de aplicativo.

Observação

Essa função foi substituída pela função LoadImage (com LR_DEFAULTSIZE e sinalizadores de LR_SHARED definidos).

Sintaxe

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

Parâmetros

[in, optional] hInstance

Tipo: HINSTANCE

Um identificador para o módulo de um arquivo DLL ou executável (.exe) que contém o cursor a ser carregado. Para obter mais informações, consulte GetModuleHandle.

Para carregar um cursor de sistema predefinido, defina esse parâmetro como NULL.

[in] lpCursorName

Tipo: LPCTSTR

Se hInstance não for NULL, lpCursorName especificará o recurso de cursor por nome ou ordinal. Esse ordinal deve ser empacotado usando a macro MAKEINTRESOURCE .

Se hInstance for NULL, lpCursorName especificará o identificador (começando com o prefixo IDC_) de um cursor de sistema predefinido a ser carregado.

Valor retornado

Tipo: HCURSOR

Se a função for bem-sucedida, o valor retornado será o identificador para o cursor recém-carregado.

Se a função falhar, o valor retornado será NULL. Para obter informações de erro estendidas, chame GetLastError.

Comentários

A função LoadCursor carregará o recurso de cursor somente se ele não tiver sido carregado; caso contrário, ele recupera o identificador para o recurso existente. Essa função retornará um identificador de cursor válido somente se o parâmetro lpCursorName for um ponteiro para um recurso de cursor. Se lpCursorName for um ponteiro para qualquer tipo de recurso que não seja um cursor (como um ícone), o valor retornado não será NULL, mesmo que não seja um identificador de cursor válido.

A função LoadCursor pesquisa o recurso de cursor mais apropriado para o cursor do dispositivo de exibição atual. O recurso de cursor pode ser uma cor ou bitmap monocromático.

Virtualização de DPI

Essa API não participa da virtualização de DPI. A saída retornada não é afetada pelo DPI do thread de chamada.

Exemplos

Para obter um exemplo, consulte Criando um cursor.

Observação

O cabeçalho winuser.h define LoadCursor como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.

Requisitos


Cliente mínimo com suporte	Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	winuser.h (inclua Windows.h)
Biblioteca	User32.lib
DLL	User32.dll