CWnd::CreateCaret

Syntax

void CreateCaret( CBitmap* pBitmap );

Parameters

pBitmap

Identifies the bitmap that defines the caret shape.

Remarks

Creates a new shape for the system caret and claims ownership of the caret.

The bitmap must have previously been created by using the CBitmap::CreateBitmap member function, CreateDIBitmap Windows function, or the CBitmap::LoadBitmap member function.

Automatically destroys the previous caret shape, if any, regardless of which window owns the caret. Once created, the caret is initially hidden. To show the caret, the ShowCaret member function must be called. The system caret is a shared resource. CWnd should create a caret only when it has the input focus or is active. It should destroy the caret before losing the input focus or becoming inactive.

See Also

CBitmap::CreateBitmap, ::CreateDIBitmap, ::DestroyCaret, CBitmap::LoadBitmap, CWnd::ShowCaret, ::CreateCaret