Rational Developer for System z
Enterprise COBOL for z/OS, Version 4.1, Programming Guide


Symbol record: X'0042'

The following table shows the contents of the symbol record.

Table 1. SYSADATA symbol record
Field Size Description
Symbol ID FL4 Unique ID of symbol
Line number FL4 The listing line number of the source record in which the symbol is defined or declared
Level XL1 True level-number of symbol (or relative level-number of a data item within a structure). For COBOL, this can be in the range 01-49, 66 (for RENAMES items), 77, or 88 (for condition items).
Qualification indicator XL1
X'00'
Unique name; no qualification needed.
X'01'
This data item needs qualification. The name is not unique within the program. This field applies only when this data item is not the level-01 name.
Symbol type XL1
X'68'
Class-name (Class-ID)
X'58'
Method-name
X'40'
Data-name
X'20'
Procedure-name
X'10'
Mnemonic-name
X'08'
Program-name
X'81'
Reserved

The following are ORed into the above types, when applicable:

X'04'
External
X'02'
Global
Symbol attribute XL1
X'01'
Numeric
X'02'
Elementary character of one of these classes:
  • Alphabetic
  • Alphanumeric
  • DBCS
  • National
X'03'
Group
X'04'
Pointer
X'05'
Index data item
X'06'
Index-name
X'07'
Condition
X'0F'
File
X'10'
Sort file
X'17'
Class-name (repository)
X'18'
Object reference
Clauses XL1 Clauses specified in symbol definition.

For symbols that have a symbol attribute of Numeric (X'01'), Elementary character (X'02'), Group (X'03'), Pointer (X'04'), Index data item (X'05'), or Object reference (X'18'):

1... ....
Value
.1.. ....
Indexed
..1. ....
Redefines
...1 ....
Renames
.... 1...
Occurs
.... .1..
Has Occurs keys
.... ..1.
Occurs Depending On
.... ...1
Occurs in parent

For both file types:

1... ....
Select
.1.. ....
Assign
..1. ....
Rerun
...1 ....
Same area
.... 1...
Same record area
.... .1..
Recording mode
.... ..1.
Reserved
.... ...1
Record
    For mnemonic-name symbols:
01
CSP
02
C01
03
C02
04
C03
05
C04
06
C05
07
C06
08
C07
09
C08
10
C09
11
C10
12
C11
13
C12
14
S01
15
S02
16
S03
17
S04
18
S05
19
CONSOLE
20
SYSIN|SYSIPT
22
SYSOUT|SYSLST|SYSLIST
24
SYSPUNCH|SYSPCH
26
UPSI-0
27
UPSI-1
28
UPSI-2
29
UPSI-3
30
UPSI-4
31
UPSI-5
32
UPSI-6
33
UPSI-7
34
AFP-5A
Data flags 1 XL1 For both file types, and for symbols that have a symbol attribute of Numeric (X'01'), Elementary character (X'02'), Group (X'03'), Pointer (X'04'), Index data item (X'05'), or Object reference (X'18'):
1... ....
Redefined
.1.. ....
Renamed
..1. ....
Synchronized
...1 ....
Implicitly redefined
.... 1...
Date field
.... .1..
Implicit redefines
.... ..1.
FILLER
.... ...1
Level 77
Data flags 2 XL1 For symbols that have a symbol attribute of Numeric (X'01'):
1... ....
Binary
.1.. ....
External floating point (of USAGE DISPLAY or USAGE NATIONAL)
..1. ....
Internal floating point
...1 ....
Packed
.... 1...
External decimal (of USAGE DISPLAY or USAGE NATIONAL)
.... .1..
Scaled negative
.... ..1.
Numeric edited (of USAGE DISPLAY or USAGE NATIONAL)
.... ...1
Reserved for future use

For symbols that have a symbol attribute of Elementary character (X'02') or Group (X'03'):

1... ....
Alphabetic
.1.. ....
Alphanumeric
..1. ....
Alphanumeric edited
...1 ....
Group contains its own ODO object
.... 1...
DBCS item
.... .1..
Group variable length
.... ..1.
EGCS item
.... ...1
EGCS edited
    For both file types:
1... ....
Object of ODO in record
.1.. ....
Subject of ODO in record
..1. ....
Sequential access
...1 ....
Random access
.... 1...
Dynamic access
.... .1..
Locate mode
.... ..1.
Record area
.... ...1
Reserved for future use

Field will be zero for all other data types.

Data flags 3 XL1 For both file types:
1... ....
All records are the same length
.1.. ....
Fixed length
..1. ....
Variable length
...1 ....
Undefined
.... 1...
Spanned
.... .1..
Blocked
.... ..1.
Apply write only
.... ...1
Same sort merge area

Field will be zero for all other data types.

File organization XL1 For both file types:
1... ....
QSAM
.1.. ....
ASCII
..1. ....
Standard label
...1 ....
User label
.... 1...
VSAM sequential
.... .1..
VSAM indexed
.... ..1.
VSAM relative
.... ...1
Line sequential

Field will be zero for all other data types.

USAGE clause FL1
X'00'
USAGE IS DISPLAY
X'01'
USAGE IS COMP-1
X'02'
USAGE IS COMP-2
X'03'
USAGE IS PACKED-DECIMAL or USAGE IS COMP-3
X'04'
USAGE IS BINARY, USAGE IS COMP, or USAGE IS COMP-4
X'05'
USAGE IS DISPLAY-1
X'06'
USAGE IS POINTER
X'07'
USAGE IS INDEX
X'08'
USAGE IS PROCEDURE-POINTER
X'09'
USAGE IS OBJECT-REFERENCE
X'0B'
NATIONAL
X'0A'
FUNCTION-POINTER
Sign clause FL1
X'00'
No SIGN clause
X'01'
SIGN IS LEADING
X'02'
SIGN IS LEADING SEPARATE CHARACTER
X'03'
SIGN IS TRAILING
X'04'
SIGN IS TRAILING SEPARATE CHARACTER
Indicators FL1
X'01'
Has JUSTIFIED clause. Right-justified attribute is in effect.
X'02'
Has BLANK WHEN ZERO clause.
Size FL4 The size of this data item. The actual number of bytes this item occupies in storage. If a DBCS item, the number is in bytes, not characters. For variable-length items, this field will reflect the maximum size of storage reserved for this item by the compiler. Also known as the "Length attribute."
Precision FL1 The precision of a fixed or float data item
Scale FL1 The scale factor of a fixed data item. This is the number of digits to the right of the decimal point.
Base locator type FL1 For host:
01
Base Locator File
02
Base Locator Working-Storage
03
Base Locator Linkage Section
05
Base Locator special regs
07
Indexed by variable
09
COMREG special reg
10
UPSI switch
13
Base Locator for Varloc items
14
Base Locator for Extern data
15
Base Locator alphanumeric FUNC
16
Base Locator alphanumeric EVAL
17
Base Locator for Object data
19
Base Locator for Local-Storage
20
Factory data
21
XML-TEXT and XML-NTEXT

For Windows and AIX:

01
Base Locator File
02
Base Locator Linkage Section
03
Base Locator for Varloc items
04
Base Locator for Extern data
05
Base Locator for Object data
06
XML-TEXT and XML-NTEXT
10
Base Locator Working-Storage
11
Base Locator special regs
12
Base Locator alphanumeric FUNC
13
Base Locator alphanumeric EVAL
14
Indexed by variable
16
COMREG special reg
17
UPSI switch
18
Factory data
22
Base Locator for Local-Storage
Date format FL1 Date format:
01
YY
02
YYXX
03
YYXXXX
04
YYXXX
05
YYYY
06
YYYYXX
07
YYYYXXXX
08
YYYYXXX
09
YYX
10
YYYYX
22
XXYY
23
XXXXYY
24
XXXYY
26
XXYYYY
27
XXXXYYYY
28
XXXYYYY
29
XYY
30
XYYYY
Data flags 4 XL1 For symbols that have a symbol attribute of Numeric (X'01'):
1... ....
Numeric national

For symbols that have a symbol attribute of Elementary character (X'02'):

1... ....
National
.1.. ....
National edited

For symbols that have a symbol attribute of Group (X'03'):

1... ....
Group-Usage National
Reserved FL3 Reserved for future use
Addressing information FL4 For host, the Base Locator number and displacement:
Bits 0-4
Unused
Bits 5-19
Base Locator (BL) number
Bits 20-31
Displacement off Base Locator

For Windows and AIX, the W-code SymId.

Structure displacement AL4 Offset of symbol within structure. This offset is set to 0 for variably located items.
Parent displacement AL4 Byte offset from immediate parent of the item being defined.
Parent ID FL4 The symbol ID of the immediate parent of the item being defined.
Redefined ID FL4 The symbol ID of the data item that this item redefines, if applicable.
Start-renamed ID FL4 If this item is a level-66 item, the symbol ID of the starting COBOL data item that this item renames. If not a level-66 item, this field is set to 0.
End-renamed ID FL4 If this item is a level-66 item, the symbol ID of the ending COBOL data item that this item renames. If not a level-66 item, this field is set to 0.
Program-name symbol ID FL4 ID of the program-name of the program or the class-name of the class where this symbol is defined.
OCCURS minimum

Paragraph ID

FL4 Minimum value for OCCURS

Proc-name ID for a paragraph-name

OCCURS maximum

Section ID

FL4 Maximum value for OCCURS

Proc-name ID for a section-name

Dimensions FL4 Number of dimensions
Case bit vector XL4 The case of the characters in the symbol name is represented with one bit per character. Each bit has the following meaning:
0
Uppercase
1
Lowercase

Bit 0 represents the case of the first character, bit 1 represents the case of the second character, and so forth.

Reserved CL8 Reserved for future use
Value pairs count HL2 Count of value pairs
Symbol name length HL2 Number of characters in the symbol name
Picture data length for data-name

or

Assignment-name length for file-name

HL2 Number of characters in the picture data; zero if symbol has no associated PICTURE clause. (Length of the PICTURE field.) Length represents the field as it is found in the source input. This length does not represent the expanded field for PICTURE items that contain a replication factor. The maximum COBOL length for a PICTURE string is 50 bytes. Zero in this field indicates no PICTURE specified.

Number of characters in the external file-name if this is a file-name. This is the DD name part of the assignment-name. Zero if file-name and ASSIGN USING specified.

Initial Value length for data-name

External class-name length for CLASS-ID

HL2 Number of characters in the symbol value; zero if symbol has no initial value

Number of characters in the external class-name for CLASS-ID

ODO symbol name ID for data-name

ID of ASSIGN data-name if file-name

FL4 If data-name, ID of the ODO symbol name; zero if ODO not specified

If file-name, Symbol-ID for ASSIGN USING data-name; zero if ASSIGN TO specified

Keys count HL2 The number of keys defined
Index count HL2 Count of Index symbol IDs; zero if none specified
Symbol name CL(n)  
Picture data string for data-name

or

Assignment-name for file-name

CL(n) The PICTURE character string exactly as the user types it in. The character string includes all symbols, parentheses, and replication factor.

The external file-name if this is a file-name. This is the DD name part of the assignment-name.

Index ID list (n)FL4 ID of each index symbol name
Keys (n)XL8 This field contains data describing keys specified for an array. The following three fields are repeated as many times as specified in the 'Keys count' field.
...Key Sequence FL1 Ascending or descending indicator.
X'00'
DESCENDING
X'01'
ASCENDING
...Filler CL3 Reserved
...Key ID FL4 The symbol ID of the data item that is the key field in the array
Initial Value data for data-name

 

External class-name for CLASS-ID

CL(n) This field contains the data specified in the INITIAL VALUE clause for this symbol. The following four subfields are repeated according to the count in the 'Value pairs count' field. The total length of the data in this field is contained in the 'Initial value length' field.

The external class-name for CLASS-ID.

...1st value length HL2 Length of first value
...1st value data CL(n) 1st value.

This field contains the literal (or figurative constant) as it is specified in the VALUE clause in the source file. It includes any beginning and ending delimiters, embedded quotation marks, and SHIFT IN and SHIFT OUT characters. If the literal spans multiple lines, the lines are concatenated into one long string. If a figurative constant is specified, this field contains the actual reserved word, not the value associated with that word.

...2nd value length HL2 Length of second value, zero if not a THRU value pair
...2nd value data CL(n) 2nd value.

This field contains the literal (or figurative constant) as it is specified in the VALUE clause in the source file. It includes any beginning and ending delimiters, embedded quotation marks, and SHIFT IN and SHIFT OUT characters. If the literal spans multiple lines, the lines are concatenated into one long string. If a figurative constant is specified, this field contains the actual reserved word, not the value associated with that word.


Terms of use | Feedback

This information center is powered by Eclipse technology. (http://www.eclipse.org)