Hwnd Help

The GetWindowPlacement function retrieves the show state and the restored, minimized, and maximized positions of the specified window.

BOOL GetWindowPlacement(

HWND hWnd, // handle of window
WINDOWPLACEMENT *lpwndpl // address of structure for position data
);


Parameters

hWnd

Identifies the window.

lpwndpl

Points to the WINDOWPLACEMENT structure that receives the show state and position information.
Before calling GetWindowPlacement, set the length member of the WINDOWPLACEMENT structure to sizeof(
WINDOWPLACEMENT).
GetWindowPlacement fails if lpwndpl->length is not set correctly.



Return Values

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 flags member of WINDOWPLACEMENT retrieved by this function is always zero. If the window identified by the hWnd parameter is maximized, the showCmd member is SW_SHOWMAXIMIZED. If the window is minimized, showCmd is SW_SHOWMINIMIZED. Otherwise, it is SW_SHOWNORMAL.
The length member of WINDOWPLACEMENT must be set to sizeof(WINDOWPLACEMENT). If this member is not set correctly, the function returns FALSE.

See Also

SetWindowPlacement, WINDOWPLACEMENT

The WINDOWPLACEMENT structure contains information about the placement of a window on the screen.

typedef struct _WINDOWPLACEMENT { // wndpl
UINT length;
UINT flags;
UINT showCmd;
POINT ptMinPosition;
POINT ptMaxPosition;
RECT rcNormalPosition;
} WINDOWPLACEMENT;


Members

length

Specifies the length, in bytes, of the structure. 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

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



Value Meaning
WPF_RESTORETOMAXIMIZED
Specifies that 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
Specifies that the coordinates of the minimized window may be specified. This flag must be specified if the coordinates are set in the ptMinPosition member.


showCmd

Specifies the current show state of the window. This member can be one of the following values:



Value Meaning
SW_HIDE Hides the window and activates another window.
SW_MINIMIZE Minimizes the specified window and activates the top-level window in the system's list.
SW_RESTORE Activates and displays a window. If the window is minimized or maximized, Windows restores it to its original size and position (same as SW_SHOWNORMAL).
SW_SHOW Activates a window and displays it in its current size and position.
SW_SHOWMAXIMIZED Activates a window and displays it as a maximized window.
SW_SHOWMINIMIZED Activates a window and displays it as an icon.
SW_SHOWMINNOACTIVE Displays a window as an icon. The active window remains active.
SW_SHOWNA Displays a window in its current state. The active window remains active.
SW_SHOWNOACTIVATE Displays a window in its most recent size and position. The active window remains active.
SW_SHOWNORMAL Activates and displays a window. If the window is minimized or maximized, Windows restores it to its original size and position (same as SW_RESTORE).


ptMinPosition

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

ptMaxPosition

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

rcNormalPosition

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



See Also

ShowWindow, POINT, RECT

The POINT structure defines the x- and y- coordinates of a point.

typedef struct tagPOINT { // pt
LONG x;
LONG y;
} POINT;


Members

x

Specifies the x-coordinate of the point.

y

Specifies the y-coordinate of the point.

Type WindowPlacement
	Field length%
	Field flags%
	Field showcmd%
	Field minposX%
	Field minposY%
	Field maxposX%
	Field maxposY%
	Field normalposLeft%
	Field normalposTop%
	Field normalposRight%
	Field normalposBottom%
End Type

wp.WindowPlacement = New WindowPlacement
wp\length = 44 ; Sizeof WindowPlacement structure (bytes)

CreateWindow("GetWindowPlacement Example",100,100,200,200)
w = GetForegroundWindow()
If GetWindowPlacement(w, wp) Then
	Print "Length: " + wp\length
	Print "Flags: " + wp\flags
	Print "Showcmd: " + wp\showcmd
	Print "MinPos.x: " + wp\minposx
	Print "MinPos.y: " + wp\minposy
	Print "MaxPos.x: " + wp\maxposx
	Print "MaxPos.y: " + wp\maxposy
	Print "NormalPos.Left: " + wp\normalposLeft
	Print "NormalPos.Top: " + wp\normalposTop
	Print "NormalPos.Right: " + wp\normalposRight
	Print "NormalPos.Bottom: " + wp\normalposBottom
Else
	Notify "GetWindowPlacement call failed."
EndIf

Notify "Done."

; From Winuser.h:
;
;/*
; * ShowWindow() Commands
; */
;#define SW_HIDE 0
;#define SW_SHOWNORMAL 1
;#define SW_NORMAL 1
;#define SW_SHOWMINIMIZED 2
;#define SW_SHOWMAXIMIZED 3
;#define SW_MAXIMIZE 3
;#define SW_SHOWNOACTIVATE 4
;#define SW_SHOW 5
;#define SW_MINIMIZE 6
;#define SW_SHOWMINNOACTIVE 7
;#define SW_SHOWNA 8
;#define SW_RESTORE 9
;#define SW_SHOWDEFAULT 10
;#define SW_FORCEMINIMIZE 11
;#define SW_MAX 11

.lib "user32.dll"
GetForegroundWindow%():"GetForegroundWindow"
GetWindowPlacement%(hwnd%, lpwndpl*):"GetWindowPlacement"