CONNECT HELP
FUNCTION
This command enables you to connect to a help definition specified in Dictionary-IV and display, edit, or create help text during script execution.
SYNTAX
CONNECT HELP help-name$- help-name$
- the name of a help definition specified in Dictionary-IV.
NOTES
- This command enables you to connect to an on-line help definition from any script.
- After the help display completes, execution resumes with the following Script-IV command.
- The help display is controlled by the values specified in the HELP$[ALL] string array. If the array does not exist, Script-IV will automatically build the array. If the array exists, Script-IV will use the values in the array to control processing.
- The HELP$[ALL] string array is described below:
| HELP$[ALL] | Passed to help class from a script’s CONNECT HELP command. | ||
|---|---|---|---|
| [0] | Help function (FUNC$), which is described below. | ||
| [1] | Help code: | ||
| 1,8 | Help code specified by help-name$ | ||
| 8,40 | Help description, which is used when new help is being created. | ||
| [2] | Substitute parameters. | ||
| [3] | Returned value. |
• The FUNC$ string array is described below:
| FUNC$ | 1,1 = | “C” | Clear the help window and reselect the window prior to help. | |
|---|---|---|---|---|
| “X” | Allow scrolling, leave the help window displayed and selected. | |||
| “x” | Do not allow scrolling, leave the help window displayed and selected. | |||
| 2,1 = | “ “ | No heading. | ||
| “C” | Centered heading | |||
| “L” | Left-justified heading. | |||
| “R” | Right-justified heading. | |||
| Note: The help description is the displayed heading. | ||||
| 3,1 = | “ “ | F10 Home enabled. | ||
| “X” | F10 Home disabled. Perform defined F10 key function. | |||
| 4,1 = | “ “ | Do help for help. | ||
| “X” | Do index help module for F6 key. | |||
| 5,1 = | “ “ | F7 special functions enabled. | ||
| “X” | F7 special functions disabled. | |||
| 6,1 = | “ “ | Normal help display. | ||
| “X” | Go directly into edit help text. | |||
| 7,1 = | “ “ | Save changes to tab line. | ||
| “X” | Do not save changes to tab line. | |||
| 8,1 = | “1” | Substitute all four bytes of window create parameters: | ||
| 1 | starting column of window | |||
| 2 | starting row of window | |||
| 3 | number of columns per row | |||
| 4 | number of rows per window | |||
| “2” | Substitute only the starting column and row. | |||
| “3” | Substitute only the number of columns and rows. | |||
| 9,1 = | Substitute value for starting column of window (ASC). | |||
| 10,1 = | Substitute value for starting row of window (ASC). | |||
| 11,1 = | Substitute value for number of columns per row (ASC). | |||
| 12,1 = | Substitute value for number of rows per window (ASC). | |||
| 13,1 = | “X” | Read the help text, unpack it, and return just the text in TAB$[ALL]. |
EXAMPLES
CONNECT HELP "4SHELP1"SEE ALSO
CONNECT MENU, CONNECT QUERY, CONNECT REPORT, CONNECT SCREEN, CONNECT VIEW, PRINT HELP. For more information on how to edit and maintain help definitions see the Dictionary-IV Developer Guide.
From the Script-IV Language Reference, version 8.9.1. Open this page in the PDF