Show contents of variables
Component: | SDF-P-BASYS |
Functional area: | Procedures |
Domain: | PROCEDURE |
Privileges: | STD-PROCESSING |
Function
The SHOW-VARIABLE command outputs the contents of variables. Possible output media are SYSOUT, SYSLST, file, list variable or library element.
Output format
The contents of a variable of type INTEGER are output as a string of characters 0-9, possibly with a leading minus sign.
The contents of a variable of type BOOLEAN are output as the character string FALSE or TRUE.
The order in which the contents of variable elements are output is equivalent to the order of the element declarations for complex variables having the type “structure” and to the numerical order of the array indices for complex variables having the type “array”.
The output always begins on a new line for each variable.
Restrictions
If the chargeable SDF-P subsystem is not available, the following restrictions apply:
Only the contents of simple S variables are output. When variable names are specified explicitly, only simple S variables can be specified.
Output to a list variable (OUTPUT=*VARIABLE) is not possible.
Within the structure *BY-ATTRIBUTES(...) (SELECT operand), only the respective default values may be specified for SCOPE and INITIALIZATION; the same applies to VALUE and NAME in the structure *PARAMETERS(...) (INFORMATION operand).
Format
SHOW-VARIABLE | Alias: SHV | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Operands
VARIABLE-NAME =
Designates the variables to be output.
VARIABLE-NAME = *ALL
Default value. All variables having the scope specified under SCOPE are output in the alphabetical order of their variable names. Elements in structures are output in the order of their declarations, while array elements are output in the numerical order of their array indices.
VARIABLE-NAME = list-poss(2000): <composed-name 1..255>
Names of the variables to be output.
These names are output in the specified order.
VARIABLE-NAME = <structured-name 1..20 with-wild(40)>
The variables whose names correspond to the search pattern are output in the lexical order of their names.
SELECT = *BY-ATTRIBUTES(...)
Designates more precisely the variables to be output.
SCOPE = *VISIBLE / *PROCEDURE / *CURRENT / *CURRENT-PARAMETERS / *TASK-ALL /
*TASK-VISIBLE / *CALLING-PROCEDURES
Designates the scope of the variables to be output.
SCOPE = *VISIBLE
Outputs all visible variables.
A variable is visible if it is not overlaid by a declaration in an include procedure.
The operand values *PROCEDURE, *CURRENT, *CURRENT-PARAMETERS, *TASK-ALL, *TASK-VISIBLE and *CALLING-PROCEDURES can only be specified if the chargeable SDF-P subsystem is loaded. The operand values are completely described in the “SDF-P” manual [34].
INITIALIZATION = *YES / *ANY
Specifies whether noninitialized variables are to be output.
INITIALIZATION = *YES
Only initialized variables are output.
The operand value *ANY can only be specified if the chargeable SDF-P subsystem is loaded. The operand value *ANY is completely described in the “SDF-P” manual [34].
INFORMATION = *PARAMETERS(...)
Specifies the information which is output.
VALUE = *WITHOUT-QUOTES / *C-LITERAL / *X-LITERAL / *NONE
Specifies whether the values of the variables should be output, and in what format.
VALUE = *WITHOUT-QUOTES
Outputs variables with the data type STRING, without apostrophes.
The operand values *C-LITERAL, *X-LITERAL and *NONE can only be specified if the chargeable SDF-P subsystem is loaded. The operand values are completely described in the “SDF-P” manual [34].
NAME = *FULL-NAME(...) / *ELEMENT-NAME(...) / *NONE
Specifies the format in which the names of the variables are output.
NAME = *FULL-NAME(...)
Outputs full variable names.
LIST-INDEX-NUMBER = *NO / *YES
Defines whether the elements of a list are to have the element number appended to them instead of the suffix (*LIST).
The operand values *ELEMENT-NAME and *NONE can only be specified if the chargeable SDF-P subsystem is loaded. The operand values are completely described “SDF-P” manual [34].
OUTPUT =
Designates the output medium.
OUTPUT = *SYSOUT
Output to SYSOUT.
OUTPUT = *SYSLST
Output to SYSLST.
OUTPUT = <filename 1..54 without-gen-vers>(...)
Output to the specified file, which must be a SAM file.
WRITE-MODE = *REPLACE
The current contents of the file are to be overwritten.
WRITE-MODE = *EXTEND
The output is to be appended to the current contents.
OUTPUT = *VARIABLE(...)
Only possible if the chargeable SDF-P subsystem is available.
Output to a list variable.
VARIABLE-NAME = <structured-name 1..20>
Name of the list variable.
WRITE-MODE = *REPLACE
The current contents of the list variable are to be overwritten.
WRITE-MODE = *EXTEND
The list variable is to be extended, i.e. the output is to be appended to the current contents.
OUTPUT = *LIBRARY-ELEMENT(...)
Output to an element in a PLAM library.
LIBRARY = <filename 1..54 without-vers>
Name of the PLAM library.
ELEMENT = <composed-name 1..64>(...)
Name of the element.
VERSION =
Designates the version of the element.
VERSION = *HIGHEST-EXISTING
Selects the highest existing version.
VERSION = *UPPER-LIMIT
Selects the highest possible version.
VERSION = <composed-name 1..24>
Selects the specified version.
TYPE = S / alphanum-name 1..8
Designates the element type.
WRITE-MODE = *REPLACE
The current contents of the element are to be overwritten.
WRITE-MODE = *EXTEND
The element is to be extended, i.e. the output is to be appended to the current contents.
Return codes
It is possible that part of the command has been processed and executed when the error occurs. In this case, the result of the command is not guaranteed.
(SC2) | SC1 | Maincode | Meaning/Guaranteed messages |
|---|---|---|---|
0 | CMD0001 | No error | |
1 | 0 | CMD0001 | Warning: variable not found |
1 | CMD0202 | Syntax error | |
3 | CMD2203 | Incorrect syntax file | |
32 | CMD0221 | System error (internal error) | |
64 | CMD0216 | User does not have required privilege | |
64 | SDP0091 | Semantic error | |
130 | SDP0099 | No more address space available |