Important Notice

The pages on this site contain documentation for very old MS-DOS software, purely for historical purposes. If you're looking for up-to-date documentation, particularly for programming, you should not rely on the information found here, as it will be woefully out of date.

◄Function Group►  ◄Overview►  ◄Changes►               ◄Up► ◄Next► ◄Previous►
────────────────────────────────────────────────────────────────────────────
 
#define INCL_WINHELP
 
BOOL WinAssociateHelpInstance(hwndHelpInstance, hwndApp)
HWND hwndHelpInstance;    /* handle of help instance         */
HWND hwndApp;             /* application-window handle       */
 
The WinAssociateHelpInstance function associates a help instance with a
specified application window.
 
Parameter         Description
────────────────────────────────────────────────────────────────────────────
 
 
hwndHelpInstance  Identifies the help instance. This handle must have been
                  previously created by using the WinCreateHelpInstance
                  function. If this parameter is NULL, the association (if
                  any) between the help instance and the window is removed.
 
hwndApp           Identifies the application window with which the help
                  instance is associated.
 
Return Value
 
The return value is TRUE if the function is successful or FALSE if an error
occurs.
 
Errors
 
Use the WinGetLastError function to retrieve the error value, which may be
one of the following:
 
     HMERR_INVALID_ASSOC_HELP_INST
     HMERR_INVALID_HELP_INSTANCE_HDL
     HMERR_NO_FRAME_WND_IN_CHAIN
     HMERR_INVALID_ASSOC_APP_WND
 
Comments
 
A help instance can be associated with any application window that has a
frame, but the help instance should contain help information relating to
this application window and the windows in its window chain.
 
See Also
 
WinCreateHelpInstance
 
                                      ♦