SysvalDescriptor Command

Overview

The “SysvalDescriptor Command” prints the description of a system variable in the prompt
window. Use it when you have found a variable name with the “Var Command” and want to know
what it controls, what type it has and what it is set to right now.

The command can be started in the following way:

Enter “_CmdSysvalDescriptor” in the prompt window.

Usage

Here is an explanation of how the “SysvalDescriptor Command” is typically used:

Start the command.
Enter the name of the system variable you want to know about, for example
“MCPSERVERPORT”. Upper and lower case are not distinguished.
The description of that variable is printed in the prompt window.

Name : MCPSERVERPORT
Summary : MCP server port
Type : Int
Value : 8765
Detail : The port the MCP server listens on. If it is busy, the next ports (up to +9) are tried.

The lines that are printed are the following. “Detail” is left out when the variable has no
longer description.

Name the name of the variable, the name you use with the “Var Command” and the “SetVar Command”
Summary what the variable is, the same text as the caption in the Options dialog
Type the type of the value, for example Bool, Int, Real, Str, Flg or Color
Value the value the variable holds at the moment
Choices the values you may enter, printed for variables of the type Flg only
ReadOnly printed as “Yes” for variables that cannot be changed
Detail the longer explanation, the same text as the description in the Options dialog

When you press Enter without typing a name, every system variable is listed instead, one
per line, with its summary after the name.

Alias : Comamnd Alias
AliasVar : System variable Alias
ColorBackground : Back ground color

The variables that are not available in your edition are not described. The name of such a
variable is reported as not found. The list contains the same variables as the “Var
Command”.

This command only shows the variables. Enter the name of a variable on its own, or use the
“SetVar Command”, to change one. The “System Variables” section describes them all as well.

Command Name

_CmdSysvalDescriptor

Alias

None