Background documentationparam_gethelp Locate this document in the navigation structure

 

You display the stored help text for the database parameter specified.

The system outputs an OK message followed by the line with the stored help text. The line is empty if no help text is available.

Prerequisites

You have the server authorization ParamRead.

Structure

param_gethelp <parameter_name>

Options

Option

Description

<parameter_name>

Name of the database parameter

Result

OK

<help_line>

<help_line>

...

In the event of errors, see Reply Format.

More Information

Database Administration, Database Parameters