Export (0) Print
Expand All

GetCaretPos function

Copies the caret's position to the specified POINT structure.

Syntax


BOOL WINAPI GetCaretPos(
  _Out_  LPPOINT lpPoint
);

Parameters

lpPoint [out]

Type: LPPOINT

A pointer to the POINT structure that is to receive the client coordinates of the caret.

Return value

Type: BOOL

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

The caret position is always given in the client coordinates of the window that contains the caret.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Winuser.h (include Windows.h)

Library

User32.lib

DLL

User32.dll

See also

Reference
SetCaretPos
Conceptual
Carets
Other Resources
POINT

 

 

Community Additions

ADD
Show:
© 2014 Microsoft