Share via

SetActiveWindow (Compact 2013)

  • Article

3/28/2014

This function makes the specified top-level window associated with the thread calling this function the active window.

Syntax

HWND SetActiveWindow(
  HWND hWnd 
);

Parameters

  • hWnd
    [in] Handle to the top-level window to be activated.

Return Value

The handle to the window that was previously active indicates success. NULL indicates failure. To get extended error information, call GetLastError.

Remarks

The SetActiveWindow function activates a window, but not if the application is in the background. The window will be brought into the foreground - the top of z-order - if the application is in the foreground when it sets the activation.

If the window identified by the hWnd parameter was created by the calling thread, the active window status of the calling thread is set to hWnd. Otherwise, the active window status of the calling thread is set to NULL.

If you call this function with hWnd set to the handle of the child window, SetActiveWindow returns NULL and sets the extended error value to zero.

The SetForegroundWindow window function, on the other hand, activates a window and forces it into the foreground. An application should only call SetForegroundWindow if it needs to display critical errors or information that needs the user's immediate attention.

Requirements

Header

winuser.h

Library

Caret.lib

See Also

Reference

Keyboard Functions
GetActiveWindow
SetForegroundWindow
WM_ACTIVATE