Help

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">

ui_get_help	( wid, help )

Description:
Get the help keyword registered for the given widget.
Input:
widget	wid	Pointer to the widget.
Output:
STRING	help[]	Keyword used for searching.

Description:

Get the help keyword registered for the given widget.

Input:

widget

wid

Pointer to the widget.

Output:

STRING

help[]

Keyword used for searching.

ui_register_help	( wid, help )

Description:
Register help for the given widget.
Input:
widget	wid	Pointer to the widget.
STRING	help[]	Keyword used for searching.
Output:
none

Description:

Input:

widget

wid

Pointer to the widget.

STRING

help[]

Keyword used for searching.

Output:

none

ui_add_help	( keyword, path, marker )

Description:
Adds a record to the help table, providing the connection from the keyword in the widget to the help file and to the entry in that file.
Input:
STRING	keyword[]	Unique keyword to locate the marker in the frame document.
STRING	path[]	Path to the frame document.
STRING	marker[]	Frame hypertext marker.
Output:
INTEGER	<Return Value>	0 for no error. 1 for duplicate.

Description:

Adds a record to the help table, providing the connection from the keyword in the widget to the help file and to the entry in that file.

Input:

STRING

keyword[]

Unique keyword to locate the marker in the frame document.

STRING

path[]

Path to the frame document.

STRING

marker[]

Frame hypertext marker.

Output:

INTEGER

0 for no error.
1 for duplicate.

When the help keyword is triggered due to a request for help, the frame document as specified in the path is opened and positioned to the specified hypertext marker. The path given is typically a partial path to a help file, such as “userapp/appinfo.doc”. MSC.Patran will search for this file path in each directory in the PCL path starting with the current directory. If not found MSC.Patran will then see if a unix environment variable “P3_HELP_DIRECTORY” is set and if so will search under this directory for the file. If still not found, MSC.Patran will look for a directory called “helpfiles” in the PCL path and look for the file path under that directory. Used in conjunction with ui_register_help.