CM QUERYVIEWPORTRECT

This message returns a rectangle that contains the coordinates of the container's client area. These are virtual coordinates that are relative to the origin of the coordinate space requested.

Syntax

param1
PRECTL prclViewport;      /* Pointer to the RECTL structure. */

param2
USHORT usIndicator;       /* Coordinate space indicator. */
BOOL fRightSplitWindow; /* Flag. */

Parameters

prclViewport (PRECTL) - Output

Pointer to the RECTL structure that the virtual coordinates of the client area rectangle are to be written into.

usIndicator (USHORT) - Input

Coordinate space indicator. One of the following must be used:

CMA_WINDOW: Returns the client area rectangle in container window coordinates.

CMA_WORKSPACE: Return the client area rectangle in coordinates relative to the origin of the container's workspace.

fRightSplitWindow (BOOL) - Input

Flag that specifies the right or left window in the split details view. This flag is ignored if the view is not the split details view.

TRUE: Right split window is returned.

FALSE: Left split window is returned.

Returns

rc (BOOL) - returns

Success indicator.

TRUE: The client area rectangle was returned successfully.

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

PMERR_INVALID_PARAMETERS.

Remarks

The virtual coordinates of the client area rectangle are written into the structure addressed by the prclViewport parameter.

Default Processing

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