Microsoft Windows CE 3.0  

SetWindowPos

Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

This function changes the size, position, and z-order of a child, pop-up, or top-level window. Child, pop-up, and top-level windows are ordered according to their appearance on the screen. The topmost window receives the highest rank and is the first window in the z-order.

BOOL
SetWindowPos( HWND
hWnd
, HWND
hWndInsertAfter
, int
X
, int
Y
, int
cx
, int
cy
, UINT
uFlags
);

Parameters

hWnd
Handle to the window.
hWndInsertAfter
Handle to the window to precede the positioned window in the z-order. This parameter must be a window handle or one of the following values:
Value Description
HWND_BOTTOM Places the window at the bottom of the z-order. If the hWndparameter identifies a topmost window, the window loses its topmost status and is placed at the bottom of all other windows.
HWND_NOTOPMOST Places the window above all non-topmost windows (that is, behind all topmost windows). This flag has no effect if the window is already a non-topmost window. This value is not supported in Windows CE versions 1.0 and 1.01.
HWND_TOP Places the window at the top of the z-order.
HWND_TOPMOST Places the window above all non-topmost windows. The window maintains its topmost position even when it is deactivated. This value is not supported in Windows CE versions 1.0 and 1.01.

For more information about how this parameter is used, see the following Remarks section.

X
Specifies the new position of the left side of the window, in client coordinates.
Y
Specifies the new position of the top of the window, in client coordinates.
cx
Specifies the new width of the window, in pixels.
cy
Specifies the new height of the window, in pixels.
uFlags
Specifies the window sizing and positioning flags. This parameter can be a combination of the following values:
Value Description
SWP_DRAWFRAME Draws a frame (defined in the window's class description) around the window. This value is not supported in Windows CE versions 1.0 and 1.01.
SWP_FRAMECHANGED Sends a WM_NCCALCSIZE message to the window, even if the window's size is not being changed. If this flag is not specified, WM_NCCALCSIZE is sent only when the window's size is being changed.
SWP_HIDEWINDOW Hides the window.
SWP_NOACTIVATE Does not activate the window. If this flag is not set, the window is activated and moved to the top of either the topmost or non-topmost group (depending on the setting of the hWndInsertAfterparameter).
SWP_NOCOPYBITS Discards the entire contents of the client area. If this flag is not specified, the valid contents of the client area are saved and copied back into the client area after the window is sized or repositioned. This value is not supported in Windows CE versions 2.10 and later.
SWP_NOMOVE Retains the current position (ignores the Xand Yparameters).
SWP_NOOWNERZORDER Does not change the owner window's position in the z-order.
SWP_NOREPOSITION Same as the SWP_NOOWNERZORDER flag.
SWP_NOSIZE Retains the current size (ignores the cxand cyparameters).
SWP_NOZORDER Retains the current z-order (ignores the hWndInsertAfterparameter).
SWP_SHOWWINDOW Displays the window.

Return Values

Nonzero indicates success. Zero indicates failure. To get extended error information, call GetLastError.

Remarks

If the specified window is a visible top-level window and the SWP_NOACTIVATE flag is not specified, this function activates the window. If the window is the currently active and the SWP_HIDEWINDOW flag is specified, the activation is passed on to another visible top-level window.

A window can be made a topmost window either by setting the hWndInsertAfterparameter to HWND_TOPMOST and ensuring that the SWP_NOZORDER flag is not set, or by setting a window's position in the z-order so that it is above any existing topmost windows. When a non-topmost window is made topmost, its owned windows are also made topmost. Its owners, however, are not changed.

If neither the SWP_NOACTIVATE nor SWP_NOZORDER flag is specified (that is, when the application requests that a window be simultaneously activated and its position in the z-order changed), the value specified in hWndInsertAfteris used only in the following circumstances:

  • Neither the HWND_TOPMOST nor HWND_NOTOPMOST flag is specified in hWndInsertAfter.
  • The window identified by hWndis not the active window.

    When you set the SWP_FRAMECHANGED flag in the nFlagsparameter to this function, Windows CE redraws the entire non-client area of the window, which may change the size of the client area. This is the only way to get the non-client area to be recalculated and is typically used after a you've changed the window style by calling SetWindowLong.

    If the SWP_SHOWWINDOW or SWP_HIDEWINDOW flag is set, the window cannot be moved or sized.

    If you have changed certain window data using SetWindowLong, you must call SetWindowPosto have the changes take effect. Use the following combination for uFlags: SWP_NOMOVE | SWP_NOSIZE | SWP_NOZORDER | SWP_FRAMECHANGED.

    SetWindowPosalways causes a WM_WINDOWPOSCHANGED message to be sent to the window. The flags passed in this message are exactly the same as those passed into the function. No other messages are sent by this function.

    If an owned window was created with the WS_OVERLAPPED style, SetWindowPosuses the parent window coordinates to reposition it. If the owned window was created using the WS_POPUP style, it is repositioned using screen coordinates.

    An application cannot activate an inactive window without also bringing it to the top of the z-order. Applications can change an activated window's position in the z-order without restrictions, or it can activate a window and then move it to the top of the topmost or non-topmost windows.

    If a topmost window is repositioned to the bottom (HWND_BOTTOM) of the z-order or after any non-topmost window, it is no longer topmost. When a topmost window is made non-topmost, its owners and its owned windows are also made non-topmost windows.

    A non-topmost window can own a topmost window, but the reverse cannot occur. Any window (for example, a dialog box) owned by a topmost window is itself made a topmost window, to ensure that all owned windows stay above their owner.

    If an application is not in the foreground, and should be in the foreground, it must call the SetForegroundWindowfunction.

    Requirements

    Runs on Versions Defined in Include Link to
    Windows CE OS 1.0 and later Winuser.h    
    Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

    See Also

    MoveWindow, SetForegroundWindow, SetWindowLong, WM_WINDOWPOSCHANGED


    Last updated on Friday, May 26, 2006

    © 2004 Microsoft Corporation. All rights reserved.