DeferWindowPos (Compact 2013)

  • Article

3/28/2014

This function updates the specified deferred window position structure for the specified window.

Syntax

HDWP DeferWindowPos(
  HDWP hWinPosInfo,
  HWND hWnd,
  HWND hWndInsertAfter,
  int x,
  int y,
  int cx,
  int cy,
  UNIT uFlags
);

Parameters

  • hWinPosInfo
    [in] Handle to a deferred window position structure that contains size and position information for one or more windows. This structure is returned by BeginDeferWindowPos or by the most recent call to DeferWindowPos.
  • hWnd
    [in] Handle to the window that the hWinPosInfo parameter describes.

  • hWndInsertAfter
    [in] Handle to the window that precedes 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 hWnd parameter 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.

    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 parameter is ignored if the SWP_NOZORDER flag is set in the uFlags parameter.

  • x
    [in] Specifies the x-coordinate of the window's upper-left corner.
  • y
    [in] Specifies the y-coordinate of the window's upper-left corner.
  • cx
    [in] Specifies the window's new width, in pixels.
  • cy
    [in] Specifies the window's new height, in pixels.

  • uFlags
    [in] Specifies a combination of the following values that affect the size and position of the window.

    Value

    Description

    SWP_DRAWFRAME

    Unsupported in Windows Embedded Compact.

    SWP_FRAMECHANGED

    Causes the OS to recalculate the size and position of the windows client area, even if the window size is not being changed. If this flag is not specified, the client area is recalculated only when the size or position of the window changes.

    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 hWndInsertAfter parameter).

    SWP_NOCOPYBITS

    Unsupported in Windows Embedded Compact.

    SWP_NOMOVE

    Retains the current position (ignores the X and Y parameters).

    SWP_NOOWNERZORDER

    Does not change the owner window's position in the z-order.

    SWP_NOREDRAW

    Unsupported in Windows Embedded Compact.

    SWP_NOREPOSITION

    Same as the SWP_NOOWNERZORDER flag.

    SWP_NOSENDCHANGING

    Unsupported in Windows Embedded Compact.

    SWP_NOSIZE

    Retains the current size (ignores the cx and cy parameters).

    SWP_NOZORDER

    Retains the current z-order (ignores the hWndInsertAfter parameter).

    SWP_SHOWWINDOW

    Displays the window.

Return Value

Returns the handle to the updated HDWP internal structure.

The return value identifies the updated deferred window position structure. The handle returned by this function may differ from the handle passed to the function. Pass the new handle that this function returns into the next call to DeferWindowPos or EndDeferWindowPos.

A return value of NULL indicates that system resources are not available for the function to succeed. To get extended error information, call GetLastError.

Remarks

The EndDeferWindowPos function uses the information in this structure to change the position and size of a number of windows simultaneously. The BeginDeferWindowPos function creates the structure.

If a call to DeferWindowPos fails, the application should stop the window-positioning operation and not call EndDeferWindowPos.

If SWP_NOZORDER is not specified, the system places the window of the hWnd handle in the position following the window of the hWndInsertAfter handle. If hWndInsertAfter is NULL or HWND_TOP, the system places the hWnd window at the top of the z-order. If hWndInsertAfter is set to HWND_BOTTOM, the system places the hWnd window at the bottom of the z-order.

All coordinates for child windows are relative to the upper-left corner of the parent window's client area.

The topmost window receives the highest rank and is the first window in the z-order.

A window can be made a topmost window either by setting hWndInsertAfter to the HWND_TOPMOST flag and ensuring that the SWP_NOZORDER flag is not set, or by setting the 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 hWndInsertAfter is used only in the following circumstances:

  • Neither the HWND_TOPMOST nor HWND_NOTOPMOST flag is specified in hWndInsertAfter.
  • The window of the hWnd handle is not the active window.

An application cannot activate an inactive window without also bringing it to the top of the z-order. An application 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.

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

A non-topmost window may own a topmost window, but not vice versa. 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.

Requirements

Header

winuser.h

See Also

Reference

Window Functions
BeginDeferWindowPos
EndDeferWindowPos