EmEditor Home - EmEditor Help - Plug-in Reference - Messages

EE_SET_CARET_POS

Moves the cursor position and optionally extends the selection. You can send this message explicitly or by using the Editor_SetCaretPos inline function or the Editor_SetCaretPosEx inline function.

EE_SET_CARET_POS
    wParam = MAKEWPARAM( nLogical, bExtend );
    lParam = (LPARAM) (POINT_PTR*) pptPos;

Parameters

nLogical

Specifies a combination of the following values.

Value Meaning
POS_VIEW Display Coordinates
POS_LOGICAL_A Logical Coordinates (Count double-byte characters as two)
POS_LOGICAL_W Logical Coordinates (Count double-byte characters as one)
POS_SCROLL_DONT_CARE The cursor position becomes where the scrolling becomes minimum.
POS_SCROLL_CENTER The cursor position becomes near the center of the window.
POS_SCROLL_TOP The cursor position becomes the top of the window.

bExtend

Determines whether to extend the current selection. If bExtend is TRUE, then the active end of the selection moves to the location while the anchor end remains where it is. Otherwise, both ends are moved to the specified location.

pptPos

Pointer to a POINT_PTR structure that specified the cursor position.

Return Values

The return value is not used.

Version

Supported on Version 4.03 or later. However, POS_SCROLL_DONT_CARE, POS_SCROLL_CENTER, and POS_SCROLL_TOP flags are supported on Version 6.00 or later.

Copyright 2003-2014 by Emurasoft, Inc.