Filter
Top Products
Utility Library Chapter 8
LabWindows/CVI Standard Libraries 8-80 © National Instruments Corporation
Parameters
Input
helpFile
string Points to a string containing the
help file that the Help
application is to display.
command
unsigned integer Specifies the type of help
requested.
additionalLongData
unsigned long
integer
This value parameter depends
on the command parameter as
described in the Parameter
Discussion.
additionalStringData
string This value parameter depends
on the command parameter as
described in the Parameter
Discussion.
Return Value
status
integer Non-zero on success, zero on
failure.
Parameter Discussion
helpFile contains a filename that may be followed by an angle bracket (<) and the name of a
secondary window if the topic is to be displayed in a secondary window rather than in the
primary window. The name of the secondary window must have been defined in the [WINDOWS]
section of the Help Project (.HPJ) file.
command can be one of the following values:
HELP_COMMAND—Execute a Help Macro. In this case, additionalStringData is the Help
macro to be executed.
HELP_CONTENTS—Displays the Help contents topic as defined by the Contents option in the
[OPTIONS] section of the .HPJ file.
HELP_CONTEXT—Display Help for a particular topic identified by a context number that has
been defined in the [MAP] section of the .HPJ file. In this case, additionalLongData is the
context number of the topic.
HELP_CONTEXTNOFOCUS—Display Help for a particular topic identified by a context number
that has been defined in the [MAP] section of the .HPJ file. Help does not change the focus to
the window displaying the topic.