LBR$Get_Help

Retrieve help text

LBR$Get_Help retrieves help text.

Format:

LBR$Get_Help context {line_width} {routine} {data} {key}

Returns:

Returns a condition code.

Arguments:

context

The address of a 64-bit context value returned by LB_INI_CONTROL that indicates the library to flush.

line_width

The address of a 64-bit value indicating the maximum line width for displayed text. The data passed to the routine will be broken into lines of this length using CRLF characters. Note that any single word that exceeds the line width will be on a line by itself and will exceed the line-length (it is not truncated to fit). A "word" is delimited by whitespace (one or more spaces and/or tabs). If a value of 0 is used, the text is returned as-is, with no inserted line breaks. However, line breaks within the module are not removed.

routine

The address of a callback routine. This routine is called each time help text is to be displayed. Two parameters are passed to the routine. The first is the value passed in the data argument. The second is the address of a TSRB structure that points to the complete help text. This data is only valid until the callback routine returns.

data

The address of a 64-bit integer value to be passed to the callback routine.

key

The address of a TSRB structure that points to the name of the help module to be returned. If the name is "*", the module named "Index" and the modules referenced by it will be returned. If the name is "*...", all modules are returned, in no particular order. If the key is 0 or name is null, the root module is returned. By convention, the module named "Index" is considered to be the root of the help library. If no key is given and no module named "Index" is found, an error is returned.

Description

Returns the specified help module text. Note that most application programs use LBR_OUTPUT_HELP to display help.

Condition Codes Returned: