Função ClipCursor (winuser.h)

Artigo
03/04/2024

Limita o cursor a uma área retangular na tela. Se uma posição de cursor subsequente (definida pela função SetCursorPos ou pelo mouse) estiver fora do retângulo, o sistema ajustará automaticamente a posição para manter o cursor dentro da área retangular.

Sintaxe

BOOL ClipCursor(
  [in, optional] const RECT *lpRect
);

Parâmetros

[in, optional] lpRect

Tipo: const RECT*

Um ponteiro para a estrutura que contém as coordenadas de tela dos cantos superior esquerdo e inferior direito do retângulo de confinamento. Se esse parâmetro for NULL, o cursor estará livre para se mover para qualquer lugar na tela.

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

O cursor é um recurso compartilhado. Se um aplicativo limitar o cursor, ele deverá liberar o cursor usando ClipCursor antes de abrir mão do controle para outro aplicativo.

O processo de chamada deve ter WINSTA_WRITEATTRIBUTES acesso à estação de janela.

Exemplos

Para obter um exemplo, consulte Confining a 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