Help()

Summary

Opens a help file at a specified topic.

 

Changes

In Version 5.0 added support for CHM files. In Version 6.0/2012 extended the syntax for help_topic.

 

Syntax

Help(string help_topic)

 

Argument	Contents
help_topic	One of the following:   - A help topic in the default help file   - A help file and a help topic separated by a vertical bar   - A help folder in a .CHM help file and a help topic separated by a vertical bar   - A .CHM help file, a help folder, and a help topic separated by vertical bars

 

Notes

• WinHelp (.hlp files) and compiled HTML Help (.chm) files are supported.

• If help_topic is a topic string then the default help file, as set by SetHelpFile(), is opened at the specified topic.

• If help_topic has two elements separated by a vertical bar, the first portion is extracted and if a help file with that name exists, it is used. If not, and the default help file is a .CHM file, the first portion is assumed to be a help folder in the .CHM help file. The specified help file or help folder is opened at the specified topic.

• If help_topic has three elements separated by vertical bars, the first element must be a .CHM help file, the second element is a help folder within that .CHM help file, and the third element is a help topic within that help folder. The specified help file and help folder are opened at the specified topic.

• If the help file does not have an extension then Maptitude first looks for a help file with the same extension as the default help file, and if not found Maptitude searches for one with the other extension.

Examples

Help("Opening_a_File")

Help("c:\\myapp\\myfile.chm|Creating_a_Map")

Help("main|Moving_Around_a_Map")

Help("c:\\myapp\\myfile.chm|sub|Customizing_the_Legend")

 

Error Codes

Error Type	Meaning
NotFound	The specified help file does not exist, or a help folder was specified and the help file is an .HLP file

 

See Also

Function	Summary
SetHelpFile()	Sets the default help file used by subsequent help queries