INDEX CLUSTER FEATURES SHORT FRAMES NO FRAMES

indexing

title: "HTML Help API functions"
project: "Visual Eiffel Win32 Library"
revision: "$Revision: 1.1 $"
copyright: "Copyright (C) 1996-2005 Object Tools Group"
license: "http://visual-eiffel.com/license"
cluster: htmlhelp
class WAPI_HTMLHELP_FUNCTIONS
feature -- Access

HtmlHelpA (hwndcaller: INTEGER; pszfile: POINTER; ucommand: INTEGER; dwdata: INTEGER): INTEGER
-- Display a help window
--
-- Parameters:
--
-- hwndCaller
--
-- Specifies the handle (hwnd) of the window calling
-- HtmlHelp(). The help window is owned by this window. When
-- the help window is closed, HtmlHelp() will return focus to
-- the owner unless the owner is the desktop. If hwndCaller
-- is the desktop, then the operating system determines where
-- focus is returned.
--
-- In addition, if HtmlHelp() sends any notification messages
-- from the help window, they are sent to hwndCaller as long
-- as you have enabled notification message tracking in the
-- help window definition.
--
-- pszFile
--
-- Depending on the uCommand value, specifies the file path
-- to either a compiled help (.chm) file, or a topic file
-- within a specified help file. A window type name can also
-- be specified, preceded with a greater-than (>) character.
--
-- If the specified command does not require a file, this
-- value may be NULL.
--
-- uCommand
--
-- Specifies the command to complete.
--
-- dwData
--
-- Specifies any data that may be required, based on the
-- value of the uCommand parameter.
--
-- Return value
--
-- Depending on the specified uCommand and the result,
-- HtmlHelp returns one or both of the following:
--
-- The handle (hwnd) of the help window.
--
-- NULL. In some cases, NULL indicates failure; in other
-- cases, NULL indicates that the help window has not yet
-- been created.

HtmlHelpW (hwndcaller: INTEGER; pszfile: POINTER; ucommand: INTEGER; dwdata: INTEGER): INTEGER
-- Display a help window
--
-- Parameters:
--
-- hwndCaller
--
-- Specifies the handle (hwnd) of the window calling
-- HtmlHelp(). The help window is owned by this window. When
-- the help window is closed, HtmlHelp() will return focus to
-- the owner unless the owner is the desktop. If hwndCaller
-- is the desktop, then the operating system determines where
-- focus is returned.
--
-- In addition, if HtmlHelp() sends any notification messages
-- from the help window, they are sent to hwndCaller as long
-- as you have enabled notification message tracking in the
-- help window definition.
--
-- pszFile
--
-- Depending on the uCommand value, specifies the file path
-- to either a compiled help (.chm) file, or a topic file
-- within a specified help file. A window type name can also
-- be specified, preceded with a greater-than (>) character.
--
-- If the specified command does not require a file, this
-- value may be NULL.
--
-- uCommand
--
-- Specifies the command to complete.
--
-- dwData
--
-- Specifies any data that may be required, based on the
-- value of the uCommand parameter.
--
-- Return value
--
-- Depending on the specified uCommand and the result,
-- HtmlHelp returns one or both of the following:
--
-- The handle (hwnd) of the help window.
--
-- NULL. In some cases, NULL indicates failure; in other
-- cases, NULL indicates that the help window has not yet
-- been created.
end -- class WAPI_HTMLHELP_FUNCTIONS

INDEX CLUSTER FEATURES SHORT FRAMES NO FRAMES