HM SET ACTIVE WINDOW: Difference between revisions
Created page with "{{DISPLAYTITLE:HM_SET_ACTIVE_WINDOW}} This message allows the application to change the window with which the Help Manager communicates and the window to which the help window is to be positioned. ==Syntax== <pre> param1 HWND hwndActiveWindow; →The handle of the window to be made active.: param2 HWND hwndRelativeWindow; →The handle of the window next to which the help window is to be positioned.: </pre> ==Parameters== ;hwndActiveW..." |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:HM_SET_ACTIVE_WINDOW}} | {{DISPLAYTITLE:HM_SET_ACTIVE_WINDOW}} | ||
This message allows the application to change the window with which the Help | This message allows the application to change the window with which the Help Manager communicates and the window to which the help window is to be positioned. | ||
Manager communicates and the window to which the help window is to be positioned. | |||
==Syntax== | ==Syntax== | ||
| Line 15: | Line 14: | ||
==Parameters== | ==Parameters== | ||
;hwndActiveWindow ([[HWND]]) - input: The handle of the window to be made active. | ;hwndActiveWindow ([[HWND]]) - input: The handle of the window to be made active. | ||
::Its window procedure receives all messages from the Help Manager until the | ::Its window procedure receives all messages from the Help Manager until the application changes the active window with another HM_SET_ACTIVE_WINDOW message. | ||
;hwndRelativeWindow ([[HWND]]) - input: The handle of the window next to which the help window is to be positioned. | |||
;hwndRelativeWindow ([[HWND]]) - input: The handle of the window next to which the help | :The handle of the application window next to which the Help Manager will position a new help window. | ||
::HWND_PARENT: This Help Manager defined constant tells the Help Manager to trace the parent chain of the window that had the focus when the user requested help. | |||
::HWND_PARENT: This Help Manager defined constant tells the Help Manager to | |||
::Other: Handle of the window next to which the help window is to be positioned. | ::Other: Handle of the window next to which the help window is to be positioned. | ||
| Line 31: | Line 26: | ||
==Remarks== | ==Remarks== | ||
Normally the Help Manager communicates with the application window with which | Normally the Help Manager communicates with the application window with which the Help Manager instance has been associated. The help window is positioned next to this same application window. | ||
the Help Manager instance has been associated. The help window is positioned | |||
next to this same application window. | |||
If the '''hwndActiveWindow''' parameter is 0, the '''hwndRelativeWindow''' parameter is | If the '''hwndActiveWindow''' parameter is 0, the '''hwndRelativeWindow''' parameter is set to 0. That is, if the active window is NULL HANDLE, the relative window is not used. | ||
set to 0. That is, if the active window is NULL HANDLE, the relative window is | |||
not used. | |||
==Default Processing== | ==Default Processing== | ||
Latest revision as of 03:20, 18 May 2025
This message allows the application to change the window with which the Help Manager communicates and the window to which the help window is to be positioned.
Syntax
param1
HWND hwndActiveWindow; /* The handle of the window to be made active. */
param2
HWND hwndRelativeWindow; /* The handle of the window next to which the help
window is to be positioned. */
Parameters
- hwndActiveWindow (HWND) - input
- The handle of the window to be made active.
- Its window procedure receives all messages from the Help Manager until the application changes the active window with another HM_SET_ACTIVE_WINDOW message.
- hwndRelativeWindow (HWND) - input
- The handle of the window next to which the help window is to be positioned.
- The handle of the application window next to which the Help Manager will position a new help window.
- HWND_PARENT: This Help Manager defined constant tells the Help Manager to trace the parent chain of the window that had the focus when the user requested help.
- Other: Handle of the window next to which the help window is to be positioned.
Returns
- rc (ULONG) - return
- Return code.
- 0: The procedure has been successfully completed.
- Other: See the values of the ulErrorCode parameter of the HM_ERROR message.
Remarks
Normally the Help Manager communicates with the application window with which the Help Manager instance has been associated. The help window is positioned next to this same application window.
If the hwndActiveWindow parameter is 0, the hwndRelativeWindow parameter is set to 0. That is, if the active window is NULL HANDLE, the relative window is not used.
Default Processing
None.