BeginDeferWindowPos

This function allocates memory for a multiple-window position structure and returns the handle to the structure.

At a Glance

Header file: Winuser.h
Windows CE versions: 2.10 and later

Syntax

HDWP BeginDeferWindowPos( int nNumWindows);

Parameters

nNumWindows

Specifies the initial number of windows for which to store position information. The DeferWindowPos function increases the size of the structure, if necessary.

Return Values

If the function succeeds, the return value identifies the multiple-window用osition structure. NULL indicates that insufficient system resources are available to allocate the structure. To get extended error information, call GetLastError.

Remarks

The multiple-window用osition structure is an internal structure; an application cannot access it directly.

DeferWindowPos fills the multiple-window用osition structure with information about the target position for one or more windows about to be moved. The EndDeferWindowPos function accepts the handle to this structure and repositions the windows by using the information stored in the structure.

If any of the windows in the multiple-window用osition structure have the SWP_HIDEWINDOW or SWP_SHOWWINDOW flag set, none of the windows are repositioned.

If the system must increase the size of the multiple-window用osition structure beyond the initial size specified by the nNumWindows parameter but cannot allocate enough memory to do so, the system fails the entire window positioning sequence (BeginDeferWindowPos, DeferWindowPos, and EndDeferWindowPos). By specifying the maximum size needed, an application can detect and process failure early in the process.

See Also

DeferWindowPos, EndDeferWindowPos