Función HideCaret (winuser.h)

Artículo
08/27/2023

Quita el símbolo de intercalación de la pantalla. Ocultar un símbolo de intercalación no destruye su forma actual ni invalida el punto de inserción.

Sintaxis

BOOL HideCaret(
  [in, optional] HWND hWnd
);

Parámetros

[in, optional] hWnd

Tipo: HWND

Identificador de la ventana que posee el símbolo de intercalación. Si este parámetro es NULL, HideCaret busca en la tarea actual la ventana propietaria del símbolo de intercalación.

Valor devuelto

Tipo: BOOL

Si la función se realiza correctamente, el valor devuelto es distinto de cero.

Si la función no se realiza correctamente, el valor devuelto es cero. Para obtener información de error extendida, llame a GetLastError.

Comentarios

HideCaret oculta el símbolo de intercalación solo si la ventana especificada posee el símbolo de intercalación. Si la ventana especificada no posee el símbolo de intercalación, HideCaret no hace nada y devuelve FALSE.

La ocultación es acumulativa. Si la aplicación llama a HideCaret cinco veces en una fila, también debe llamar a ShowCaret cinco veces antes de que se muestre el símbolo de intercalación.

Para obtener un ejemplo, vea Ocultar un símbolo de intercalación.

Requisitos


Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	winuser.h (incluya Windows.h)
Library	User32.lib
Archivo DLL	User32.dll
Conjunto de API	ext-ms-win-ntuser-caret-l1-1-0 (introducido en Windows 8)