Domain: PROCEDURE
Command description
Output medium: SYSOUT / SYSLST / file / list variable / library element
The SHOW-STRUCTURE-LAYOUT command outputs the structure layout specified with NAME=.... . The structure layout must have first been defined with BEGIN-STRUCTURE.
Note
Static structures are output with SHOW-VARIABLE ... , INFO=*PAR (VALUE = *NONE).
Format
SHOW-STRUCTURE-LAYOUT |
NAME = *ALL / <structured-name 1..20 with-wild(40)> / list-poss(2000): <structured-name 1..20> ,SCOPE = *VISIBLE / *PROCEDURE / *CURRENT / *TASK ,OUTPUT = *SYSOUT / *SYSLST / <filename 1..54 without-gen-vers>(...) / *VARIABLE(...) / *LIBRARY-ELEMENT(...) <filename 1..54 without-gen-vers>(...) WRITE-MODE = *REPLACE / *EXTEND *VARIABLE(...) VARIABLE-NAME = <composed-name 1..20> ,WRITE-MODE = *REPLACE / *EXTEND *LIBRARY-ELEMENT(...) LIBRARY = <filename 1..54 without-vers> ,ELEMENT = <composed-name 1..64>(...) <composed-name 1..64>(...) VERSION = *HIGHEST-EXISTING / *UPPER-LIMIT / <composed-name 1..24> ,TYPE = S / <alphanum-name 1..8> |
Operands
NAME =
Designates the structure layout.
NAME = *ALL
Selects all structure layouts.
NAME = <structured-name 1..20 with-wild(40)>
Name of the structure layout to be displayed.
When the name contains wildcards, all structure layouts are displayed whose names match the specified search pattern. When a wildcard string matches no structure layout, message SPD0519 is issued.
NAME = list-poss(2000): <structured-name 1..20>
One or more names of structure layouts which are to be displayed. These are displayed in the specified order.
SCOPE =
Designates the scope of the structure layout to be output.
SCOPE = *VISIBLE
Outputs all visible structure layouts in the current procedure.
A structure layout is visible if it is not covered by a declaration in an include procedure.
SCOPE = *PROCEDURE
Outputs all structure layouts, including those covered by declarations in include procedures.
SCOPE = *CURRENT
Outputs the current structure layout: within a call procedure, this is the structure layout of the procedure; within an include procedure, this is the structure layout of the include procedure.
SCOPE = *TASK
Outputs the task-global structure layout.
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 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(...)
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 number of the element.
VERSION = *HIGHEST-EXISTING
Selects the highest existing version number.
VERSION = *UPPER-LIMIT
Selects the highest possible version number.
VERSION = <composed-name 1..24>
Selects the specified version number.
TYPE = S / <alphanum-name 1..8>
Designates the element type.
Command 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 |
0 | CMD0001 | No error | |
1 | 0 | CMD0001 | Warning: no layout found |
2 | 0 | SDP2000 | Warning: not all elements of the input list could be processed successfully. Guaranteed message: SDP2000 |
1 | CMD0202 | Syntax error | |
3 | CMD2203 | Incorrect syntax file | |
32 | CMD0221 | System error (internal error) | |
64 | SDP0091 | Semantic error | |
64 | SDP1008 | Variable does not exist | |
64 | SDP2001 | None of the elements could be displayed | |
130 | SDP0099 | No further address space available |
Example
/BEGIN-STRUCTURE STRUCT-01 ———————————————————————————————————————————— (1) / DECLARE-ELEMENT ( X, Y ) /END-STRUCT STRUCT-01 /BEGIN-STRUCTURE STRUCT-02 / DECLARE-ELEMENT ( W, A ) /END-STRUCT STRUCT-02 /BEGIN-STRUCTURE STRUCT-03 / DECLARE-ELEMENT ( U, P ) /END-STRUCTURE STRUCT-03 /SHOW-STRUCTUR-LAYOUT STRUCT-0<1,3> ——————————————————————————————————— (2) STRUCT-01.X STRUCT-01.Y STRUCT-03.U STRUCT-03.P *END-OF-CMD
(1) | Structure layouts |
(2) | Output of structure layouts |