Funzione CreateCaret (winuser.h)

Articolo
05/09/2024

Crea una nuova forma per il caret di sistema e assegna la proprietà del caret alla finestra specificata. La forma caret può essere una linea, un blocco o una bitmap.

Sintassi

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

Parametri

[in] hWnd

Tipo: HWND

Handle alla finestra che possiede il caret.

[in, optional] hBitmap

Tipo: HBITMAP

Handle alla bitmap che definisce la forma caret. Se questo parametro è NULL, il caret è solido. Se questo parametro è , il cursore è (HBITMAP) 1grigio. Se questo parametro è un handle bitmap, il cursore è la bitmap specificata. L'handle bitmap deve essere stato creato dalla funzione CreateBitmap, CreateDIBitmap o LoadBitmap. Il caret viene disegnato sullo schermo tramite l'operazione XOR.

Se hBitmap è un handle bitmap, CreateCaret ignora i parametri nWidth e nHeight ; la bitmap definisce la propria larghezza e altezza. L'applicazione non deve eliminare hBitmap finché il caret non viene eliminato o sostituito da un altro caret.

[in] nWidth

Tipo: int

Larghezza del caret, in unità logiche. Se questo parametro è zero, la larghezza viene impostata sulla larghezza del bordo della finestra definita dal sistema. Se hBitmap è un handle bitmap, CreateCaret ignora questo parametro.

[in] nHeight

Tipo: int

Altezza del caret, in unità logiche. Se questo parametro è zero, l'altezza viene impostata sull'altezza del bordo della finestra definita dal sistema. Se hBitmap è un handle bitmap, CreateCaret ignora questo parametro.

Valore restituito

Tipo: BOOL

Se la funzione ha esito positivo, il valore restituito è diverso da zero.

Se la funzione ha esito negativo, il valore restituito è zero. Per informazioni dettagliate sull'errore, chiamare GetLastError.

Commenti

I parametri nWidth e nHeight specificano la larghezza e l'altezza del caret nelle unità logiche; la larghezza esatta e l'altezza, in pixel, dipendono dalla modalità di mapping della finestra.

CreateCaret elimina automaticamente la forma del caret precedente, se presente, indipendentemente dalla finestra che possiede il caret. Il caret non viene nascosto finché l'applicazione chiama la funzione ShowCaret per rendere visibile il caret.

Il sistema fornisce un caret per coda. Una finestra deve creare un caret solo quando ha lo stato attivo o lo stato attivo della tastiera. La finestra deve distruggere il caret prima di perdere lo stato attivo della tastiera o diventare inattivo.

Virtualizzazione DPI

Questa API non partecipa alla virtualizzazione DPI. I parametri di larghezza e altezza vengono interpretati come dimensioni logiche in termini di finestra in questione. Il thread chiamante non viene preso in considerazione.

Requisiti

Requisito	Valore
Client minimo supportato	Windows 2000 Professional [solo app desktop]
Server minimo supportato	Windows 2000 Server [solo app desktop]
Piattaforma di destinazione	Windows
Intestazione	winuser.h (include Windows.h)
Libreria	User32.lib
DLL	User32.dll
Set di API	ext-ms-win-ntuser-caret-l1-1-0 (introdotto in Windows 8)