Função SetCaretPos (winuser.h)

Artigo
03/09/2024

Move o cursor para as coordenadas especificadas. Se a janela que possui o cursor tiver sido criada com o estilo de classe CS_OWNDC , as coordenadas especificadas estarão sujeitas ao modo de mapeamento do contexto do dispositivo associado a essa janela.

Sintaxe

BOOL SetCaretPos(
  [in] int X,
  [in] int Y
);

Parâmetros

[in] X

Tipo: int

A nova coordenada x do cursor.

[in] Y

Tipo: int

A nova coordenada y do cursor.

Retornar valor

Tipo: BOOL

Se a função for bem-sucedida, o valor retornado será diferente de zero.

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

Comentários

SetCaretPos move o cursor se o cursor está oculto.

O sistema fornece um cursor por fila. Uma janela deve criar um cursor somente quando tiver o foco do teclado ou estiver ativo. A janela deve destruir o cursor antes de perder o foco do teclado ou ficar inativa. Uma janela só poderá definir a posição do cursor se ela for proprietária do cursor.

Virtualização de DPI

Essa API não participa da virtualização de DPI. A posição fornecida é interpretada como coordenadas lógicas em termos da janela associada ao cursor. O thread de chamada não é levado em consideração.

Exemplos

Para obter um exemplo, consulte Criando e exibindo um cursor.

Requisitos

Requisito	Valor
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
Conjunto de APIs	ext-ms-win-ntuser-caret-l1-1-0 (introduzido em Windows 8)