Función CreateCaret (winuser.h)

Artículo
05/09/2024

Crea una nueva forma para el símbolo de intercalación del sistema y asigna la propiedad del símbolo de intercalación a la ventana especificada. La forma de intercalación puede ser una línea, un bloque o un mapa de bits.

Sintaxis

BOOL CreateCaret(
  [in]           HWND    hWnd,
  [in, optional] HBITMAP hBitmap,
  [in]           int     nWidth,
  [in]           int     nHeight
);

Parámetros

[in] hWnd

Tipo: HWND

Identificador de la ventana que posee el símbolo de intercalación.

[in, optional] hBitmap

Tipo: HBITMAP

Identificador del mapa de bits que define la forma de intercalación. Si este parámetro es NULL, el símbolo de intercalación es sólido. Si este parámetro es (HBITMAP) 1, el símbolo de intercalación es gris. Si este parámetro es un identificador de mapa de bits, el símbolo de intercalación es el mapa de bits especificado. El identificador de mapa de bits debe haber sido creado por la función CreateBitmap, CreateDIBitmap o LoadBitmap . El símbolo de intercalación se dibuja en la pantalla a través de la operación XOR.

Si hBitmap es un identificador de mapa de bits, CreateCaret omite los parámetros nWidth y nHeight ; el mapa de bits define su propio ancho y alto. La aplicación no debe eliminar hBitmap hasta que el símbolo de intercalación se destruye o reemplaza por otro símbolo de intercalación.

[in] nWidth

Tipo: int

Ancho del símbolo de intercalación, en unidades lógicas. Si este parámetro es cero, el ancho se establece en el ancho del borde de la ventana definido por el sistema. Si hBitmap es un identificador de mapa de bits, CreateCaret omite este parámetro.

[in] nHeight

Tipo: int

Alto del símbolo de intercalación, en unidades lógicas. Si este parámetro es cero, el alto se establece en el alto del borde de la ventana definido por el sistema. Si hBitmap es un identificador de mapa de bits, CreateCaret omite este parámetro.

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

Los parámetros nWidth y nHeight especifican el ancho y alto del símbolo de intercalación, en unidades lógicas; el ancho y alto exactos, en píxeles, dependen del modo de asignación de la ventana.

CreateCaret destruye automáticamente la forma de intercalación anterior, si existe, independientemente de la ventana que posee el símbolo de intercalación. El símbolo de intercalación se oculta hasta que la aplicación llama a la función ShowCaret para que el símbolo de intercalación sea visible.

El sistema proporciona un símbolo de intercalación por cola. Una ventana debe crear un símbolo de intercalación solo cuando tenga el foco del teclado o esté activo. La ventana debe destruir el símbolo de intercalación antes de perder el foco del teclado o volverse inactivo.

Virtualización de PPP

Esta API no participa en la virtualización de PPP. Los parámetros width y height se interpretan como tamaños lógicos en términos de la ventana en cuestión. No se tiene en cuenta el subproceso que realiza la llamada.

Requisitos

Requisito	Value
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 (incluir Windows.h)
Library	User32.lib
Archivo DLL	User32.dll
Conjunto de API	ext-ms-win-ntuser-caret-l1-1-0 (introducido en Windows 8)