WINDOWPLACEMENT structure (winuser.h)

Contains information about the placement of a window on the screen.

Syntax

typedef struct tagWINDOWPLACEMENT {
  UINT  length;
  UINT  flags;
  UINT  showCmd;
  POINT ptMinPosition;
  POINT ptMaxPosition;
  RECT  rcNormalPosition;
  RECT  rcDevice;
} WINDOWPLACEMENT;

Members

length

Type: UINT

The length of the structure, in bytes. Before calling the GetWindowPlacement or SetWindowPlacement functions, set this member to sizeof(WINDOWPLACEMENT).

GetWindowPlacement and SetWindowPlacement fail if this member is not set correctly.

flags

Type: UINT

The flags that control the position of the minimized window and the method by which the window is restored. This member can be one or more of the following values.

Value Meaning
WPF_ASYNCWINDOWPLACEMENT
0x0004
If the calling thread and the thread that owns the window are attached to different input queues, the system posts the request to the thread that owns the window. This prevents the calling thread from blocking its execution while other threads process the request.
WPF_RESTORETOMAXIMIZED
0x0002
The restored window will be maximized, regardless of whether it was maximized before it was minimized. This setting is only valid the next time the window is restored. It does not change the default restoration behavior.

This flag is only valid when the SW_SHOWMINIMIZED value is specified for the showCmd member.

WPF_SETMINPOSITION
0x0001
The coordinates of the minimized window may be specified.

This flag must be specified if the coordinates are set in the ptMinPosition member.

showCmd

Type: UINT

The current show state of the window. It can be any of the values that can be specified in the nCmdShow parameter for the ShowWindow function.

ptMinPosition

Type: POINT

The coordinates of the window's upper-left corner when the window is minimized.

ptMaxPosition

Type: POINT

The coordinates of the window's upper-left corner when the window is maximized.

rcNormalPosition

Type: RECT

The window's coordinates when the window is in the restored position.

rcDevice

Remarks

If the window is a top-level window that does not have the WS_EX_TOOLWINDOW window style, then the coordinates represented by the following members are in workspace coordinates: ptMinPosition, ptMaxPosition, and rcNormalPosition. Otherwise, these members are in screen coordinates.

Workspace coordinates differ from screen coordinates in that they take the locations and sizes of application toolbars (including the taskbar) into account. Workspace coordinate (0,0) is the upper-left corner of the workspace area, the area of the screen not being used by application toolbars.

The coordinates used in a WINDOWPLACEMENT structure should be used only by the GetWindowPlacement and SetWindowPlacement functions. Passing workspace coordinates to functions which expect screen coordinates (such as SetWindowPos) will result in the window appearing in the wrong location. For example, if the taskbar is at the top of the screen, saving window coordinates using GetWindowPlacement and restoring them using SetWindowPos causes the window to appear to "creep" up the screen.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Header winuser.h (include Windows.h)

See also

Conceptual

GetWindowPlacement

POINT

RECT

Reference

SetWindowPlacement

SetWindowPos

ShowWindow

Windows