Expand Minimize

SetWindowPlacement function

Sets the show state and the restored, minimized, and maximized positions of the specified window.

Syntax


BOOL WINAPI SetWindowPlacement(
  _In_  HWND hWnd,
  _In_  const WINDOWPLACEMENT *lpwndpl
);

Parameters

hWnd [in]

Type: HWND

A handle to the window.

lpwndpl [in]

Type: const WINDOWPLACEMENT*

A pointer to a WINDOWPLACEMENT structure that specifies the new show state and window positions.

Before calling SetWindowPlacement, set the length member of the WINDOWPLACEMENT structure to sizeof(WINDOWPLACEMENT). SetWindowPlacement fails if the length member is not set correctly.

Return value

Type:

Type: BOOL

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

If the information specified in WINDOWPLACEMENT would result in a window that is completely off the screen, the system will automatically adjust the coordinates so that the window is visible, taking into account changes in screen resolution and multiple monitor configuration.

The length member of WINDOWPLACEMENT must be set to sizeof(WINDOWPLACEMENT). If this member is not set correctly, the function returns FALSE. For additional remarks on the proper use of window placement coordinates, see WINDOWPLACEMENT.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Winuser.h (include Windows.h)

Library

User32.lib

DLL

User32.dll

See also

Reference
GetWindowPlacement
WINDOWPLACEMENT
Conceptual
Windows

 

 

Community Additions

ADD
Show:
© 2014 Microsoft