HM QUERY

This message is sent to IPF by the application to request IPF-specific information, such as the current Instance handle, the active communication object window, the active window, or the group number of the current window.

Syntax

param1
USHORT usselectionid; /* What is being requested. */
USHORT usmessageid;   /* Type of window queried. */

param2
PVOID pvoid;         /* Varies, depending on value selected above. */

Parameters

usselectionid (USHORT) - input

What is being requested.

This parameter should be specified only if the query is for HMQW_VIEWPORT and should otherwise be coded as NULL.

Specifies whether a res ID, ID number, or group number is being requested.

The value can be any of the following constants:

HMQVP_NUMBER: A pointer to a USHORT that holds the res ID of the window.

HMQVP_NAME: A pointer to a null-terminated string that holds the ID of the window.

HMQVP_GROUP: The group number of the window.

usmessageid (USHORT) - input

Type of window queried.

Specifies the type of window to query. The value can be any of the following constants:

HMQW_INDEX: The handle of the index window.

HMQW_TOC: The handle of the Table of Contents window.

HMQW_SEARCH: The handle of the Search Hitlist window.

HMQW_VIEWEDPAGES: The handle of the Viewed Pages window.

HMQW_LIBRARY: The handle of the Library List window.

HMQW_OBJCOM_WINDOW: The handle of the active communication window.

HMQW_INSTANCE: The handle of the help instance.

HMQW_COVERPAGE: The handle of the help manager multiple document interface (MDI) parent window. It is where the secondary windows are contained within the parent window.

HMQW_VIEWPORT: The handle of the viewport window specified in the low-order word of param1 and in param2.

When HMQW_VIEWPORT is specified in usmessageid, a value must be specified in usselectionid to indicate whether a res ID, ID number, or group number is being requested.

HMQW_GROUP_VIEWPORT: The group number of the window whose handle is specified in param2.

HMQW_RES_VIEWPORT: The res number of the window whose handle is specified in param2.

HMQW_ACTIVEVIEWPORT: The handle of the currently active window.

USERDATA: The previously stored user-data.

pvoid (PVOID) - input

Varies, depending on value selected above.

param2 depends on the value of param1.usmessageid.

If param1.usmessageid is HMQW_VIEWPORT, then param2 is a pointer to the res number, ID, or group ID.

If param1.usmessageid is HMQW_GROUP_VIEWPORT, then param2 is the handle of the viewport for which the group number is assigned.

If param1.usmessageid is HMQW_RES_VIEWPORT, then param2 is the handle of the viewport for which the res number is requested.

Returns

rc (ULONG) - return

Return code.

0: The procedure was not successfully completed.

Other: The handle (HWND), group number (USHORT), or res number (USHORT) of the window, or the user data (USHORT), depending on the value of param1.usselectionid.

Default Processing

None.