Export (0) Print
Expand All
Expand Minimize

CWnd::CreateCaret

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

void CreateCaret(
   CBitmap* pBitmap 
);

Parameters

pBitmap
Identifies the bitmap that defines the caret shape.

Remarks

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

CreateCaret 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 it loses the input focus or becomes inactive.

Example

// Changes the caret of the edit control in this dialog box
void CMyDlg::OnChangeCaret() 
{
   CBitmap* pBitmap = new CBitmap;
   pBitmap->LoadBitmap(IDB_HAPPY_BITMAP);
   m_editCtrl.CreateCaret(pBitmap);
   m_editCtrl.ShowCaret();
}

See Also

CWnd Overview | Class Members | Hierarchy Chart | CBitmap::CreateBitmap | CreateDIBitmap | DestroyCaret | CBitmap::LoadBitmap | CWnd::ShowCaret | CreateCaret

Show:
© 2014 Microsoft