Background documentationparam_getexplain Locate this document in the navigation structure

 

You display the stored explanatory text for the database parameter.

The system outputs an OK message followed by the explanatory text. The line is empty, if no explanatory text is stored.

Prerequisites

You have the server authorization ParamRead.

Structure

param_getexplain <parameter_name>

Options

Option

Description

<parameter_name>

Name of the database parameter

Result

OK

<explanation_line>

<explanation_line>

...

Values for the Reply Fields

Value

Description

<explanation_line>

Explanatory text

In the event of errors, see Reply Format.

More Information

Database Administration, Database Parameters