WWHtmlHelp Functions Library

Posted on 171 views

System Requirements

InTouch®

This document refers to InTouch versions 7.0 and later.

Microsoft®

If you are going to use these two script functions in your InTouch application and then subsequently intend to install the InTouch application on a computer that does not have Microsoft Office 2000 or later installed, the components necessary to display HTML Help might not be available.

To display HTML Help, a user’s computer must have both HTML Help components and Microsoft Internet Explorer layout engine components installed.

All the components necessary to display HTML Help are installed with any of the following:

  • Microsoft Office 2000 or later
  • Microsoft Internet Explorer version 4.0 or later
  • Microsoft Windows® 98 or Windows 2000
  • Microsoft Windows NT® Server, Windows NT Workstation version 5.0, or Windows 2000 Server

If none of these are available on a user’s computer, you will need to redistribute some or all of the components necessary to display HTML Help.

WWSFShowHtmlHelpByNumber()

WWSFShowHtmlHelpByNumber() allows the user to view a help topic contained within a compiled help file (.chm) from an InTouch script.

Use

WWSFShowHtmlHelpByNumber(FilePath, TopicNumber);

FilePath This must be the fully qualified file path to the compiled help file.  These files usually end with the extension .chm, although no attempt is made to verify the file’s contents prior to invoking the help subsystem.
TopicNumber This must be the numeric value for a topic number contained within the .chm file.

Returns

Returns an integer value.

If a help window was created or successfully displayed, then the return value is 1.  In case of an error, the return value is 0.

Example of Using WWSFShowHtmlHelpByNumber()

iStatus = WWSFShowHtmlHelpByNumber( “C:\MyHelpFiles\TheHelpFile.Chm”, 27 );

WWSFShowHtmlHelpByTopic()

WWSFShowHtmlHelpByTopic() allows the user to view a help topic contained within a compiled help file (.chm) from an InTouch script.

Use

WWSFShowHtmlHelpByTopic(FilePath, TopicText);

FilePath This must be the fully qualified file path to the compiled help file. These files usually end with the extension .chm, although no attempt is made to verify the file’s contents prior to invoking the help subsystem.
TopicText This must be the name for a topic contained within the .chm file.

Returns

Returns an integer value.

If a help window was created or successfully displayed, then the return value is 1.  In case of an error, the return value is 0.

Details of WWSFShowHtmlHelpByNumber() or WWSFShowHtmlHelpByTopic()

The WWSFShowHtmlHelpByNumber and WWSFShowHtmlHelpByTopic() functions are contained in the WWHtmlHelpFuncs.dll dynamic link library.

The WWHtmlHelpFuncs.dll and WWHtmlHelpFuncs.wdf files must be in the InTouch folder for these functions to work correctly.  The functions also depend upon proper installation of the HTML help subsystem to operate correctly.

If you call a different topic while the help file is already displayed, the existing instance of the help window will change to the new topic rather than opening a new instance.

Download the necessary .dll, .chm and .html files by downloading and extracting the files.

Probable Reasons For Failure

There are many reasons this function can fail and return a value of 0, and this list attempts to document some of them:

  • HTML Help Subsystem is not properly installed or configured.
  • There is not enough memory available to create the window or invoke the HTML Help Subsystem.

WWHtmlHelpFuncs.zip Download

Leave a Reply

Your email address will not be published. Required fields are marked *

9 + 1 =