The following is a summary of the messages sent by IPF and the application
in response to user help requests.
HM_ACTIONBAR_COMMAND
This message is sent by IPF
and notifies the application that a user has selected a tailored menu bar
item.
HM_CONTROL
This message
is sent to the application or the communication object by IPF prior to the
addition of a push button in the control area of a window.
HM_CREATE_HELP_TABLE
This message is sent by the application and informs
IPF to use the new help table indicated by this address in memory.
HM_DISMISS_WINDOW
This message is sent by the application and informs
IPF to remove the active help window.
HM_DISPLAY_HELP
This message is sent by the application and informs
IPF to display a specific help window.
HM_ERROR
This message notifies the application of an error
caused by user interaction.
HM_EXT_HELP
This
message is sent by the application and informs IPF to display the extended
help window for the active application window.
HM_EXT_HELP_UNDEFINED
This message is sent by IPF and notifies the application
that an extended help window has not been defined.
HM_GENERAL_HELP
This message is sent by the application and informs
IPF to display the general help window for the active application window.
HM_GENERAL_HELP_UNDEFINED
This
message is sent by IPF and notifies the application that a general help
window has not been defined.
HM_HELP_CONTENTS
This
message is sent by the application and informs IPF to display the Contents
window.
HM_HELP_INDEX
This
message is sent by the application and informs IPF to display the help index
window.
HM_HELPSUBITEM_NOT_FOUND
This
message is sent by IPF and notifies the application that a user has requested
help on a field but that IPF cannot find a related entry in the help subtable.
HM_INFORM
This message is
sent by IPF and notifies the application that a user has selected a hypertext
field that was specified with the reftype=inform attribute of the
:link. tag.
HM_INVALIDATE_DDF_DATA
This
message is sent by the application and informs IPF that previous dynamic
data formatting (DDF) information is no longer valid.
HM_KEYS_HELP
This message is sent by the application and informs
IPF to display the keys help window.
HM_LOAD_HELP_TABLE
This message is sent by the application and provides
IPF with the module handle that contains the help table, the help subtable,
and the identity of the help table.
HM_NOTIFY
This
message is sent by IPF and notifies the application or communication object
that an event has occurred that the application may be interested in controlling.
HM_QUERY
This message is
sent by the application and notifies IPF that the application requires IPF-specific
information.
HM_QUERY_DDF_DATA
This
message is sent by IPF and notifies the communication object that IPF has
encountered the dynamic data formatting tag (:ddf.).
HM_QUERY_KEYS_HELP
This message is sent by IPF and notifies the application
that a user has requested keys help for a function.
HM_REPLACE_HELP_FOR_HELP
This message is sent by the application and informs
IPF to display the application-defined Help for Help window instead of the
IPF Help for Help window.
HM_REPLACE_USING_HELP
This message is sent by the application and informs
IPF to display the application-defined Using help window instead of the
IPF Using help window.
HM_SET_ACTIVE_WINDOW
This
message is sent by the application and enables the application to change
the active application window with which the IPF help window is associated.
HM_SET_COVERPAGE_SIZE
This
message is sent by the application and informs IPF to set the size of the
coverpage window (the window within which all other IPF windows are displayed).
HM_SET_HELP_LIBRARY_NAME
This
message is sent by the application and informs IPF to replace the list of
help libraries specified in the initialization structure with a new list.
HM_SET_HELP_WINDOW_TITLE
This
message is sent by the application and informs IPF to change the text of
a help window title.
HM_SET_OBJCOM_WINDOW
This
message is sent by the application and informs IPF to identify the communication
object to which the HM_INFORM and HM_QUERY_DDF_DATA messages are sent.
HM_SET_SHOW_PANEL_ID
This message is sent by the application and informs
IPF to display or hide window IDs for each help window.
HM_SET_USERDATA
This message is sent by the application and informs
IPF to store data in the IPF data area.
HM_TUTORIAL
This message is sent by IPF and notifies the application
when the user selects Tutorial choice from the Help menu bar.
HM_UPDATE_OBJCOM_WINDOW_CHAIN
This message is sent to the currently active communication
object by the communication object who wants to withdraw from the communication
chain.
A detailed description of the parameters and returns for these messages
follows.