SLM QUERYDETENTPOS

This message queries for the current position of a detent.

Syntax

param1
ULONG ulDetentId;   /* Detent ID. */

param2
ULONG ulReserved;    /* Reserved value, should be 0. */

returns
USHORT usDetentPos; /* Detent position. */
USHORT fDetentLocation; /* Scale. */

Parameters

ulDetentId (ULONG) - Input

Detent ID.

Unique detent identifier, which indicates the position to be returned.

ulReserved (ULONG) - Input

Reserved value, should be 0.

Returns

usDetentPos (USHORT) - returns

Detent position.

Number of pixels the detent is positioned from home.

>= 0: Number of pixels the detent is positioned from home.

SLDERR_INVALID_PARAMETERS: An error occurred. The WinGetLastError function may return the following error:

PMERR_INVALID_PARAMETERS.

fDetentLocation (USHORT) - returns

Scale.

The scale along which the detent is located. One of the following:

SMA_SCALE1: Detent position is along scale 1.

SMA_SCALE2: Detent position is along scale 2.

Remarks

An application could use this message to place text above the detent or position an item relative to it.

Default Processing

The default window procedure does not expect to receive this message and therefore takes no action on it other than to return 0.