hiLookupHRFtag

hiLookupHRFtag(
S_tagName
S_fileName
)
=> l_command / nil

Description

Returns the command that has been defined as the help response for a help tag in a .HRF file. You can get more information about the usage of this function from the your_install_dir/tools/dfII/samples/local/hrfHelp.il file.

Arguments

S_tagName

The help tag for which you want to find the help response.

S_fileName

The .HRF file in which you want to look for the help response. The contents of this file must be sorted in C sort order and must be in the following format: tagName command where tagName is the name of the help tag and command is the SKILL function that defines the response to the help request. tagName cannot contain spaces. Anything following tagName (including spaces) is considered a SKILL command. Each tagName entry can span only one line.

Value Returned

l_command	The command that has been defined as the help response for the help tag.
nil	The help tag does not exist in the file specified; the file does not exist; or the file is not sorted in C sort order, in which case the tag may not be found even if it exists in the file.

Additional Information

Cadence no longer supports help response files (.HRF files) and recommends that you convert your old .HRF files to .tgf files.

If you want to use your old .HRF files:

1. Read and follow the instructions in the following file:
   

   your_install_dir/tools/dfII/samples/local/hrfHelp.il

2. Load the hrfHelp.il file.

There is also a new function, hiLookupHRFtag, which you can use to look up help tags in .HRF files. The function is described below; for an example of its usage, see the hrfHelp.il file.

Related Topics

Online Help Functions

Return to top