Previous Topic: Program RequirementsNext Topic: Assembler User Exit Template


Assembler User Exit Control Block

Field Descriptions

In the Type column, C means character, F means fullword binary, and H means halfword binary. The macro is provided in the CA IDMS/DB macro library.

Hex Offset


Name


Type


ength


Description

0

EXBID

C

4

Contains the literal 'EXB'

4

EXBUSER

F

4

Can be used by the exit

8

EXBARWA

F

4

Exit must not modify this field

C

EXBSTACK

F

4

 

10

EXBSSCA

F

4

Address of the Subschema Control

14

FILLER

F

4

Filler

18

EXBRPLA

F

4

 

1C

EXBARGA

F

4

 

20

EXBBUFA

F

4

Address of the record in the buffer

24

EXBMXKL

H

2

Maximum key length.

26

EXBBUFL

H

2

Current length of record in the record buffer

28

EXBRECL

H

2

Contains the VSAM record length obtained from FMT

2A

EXBKEYL

H

2

Contains the VSAM key length obtained from FMT

2C

EXBKEYP

H

2

Contains the VSAM key position obtained from FMT

2E

EXBFMTNM

C

8

FMT name

36

EXBDDNM

C

8

DD name

3E

EXBRECNM

C

16

CA IDMS/DB record name

4E

EXBSETNM

C

16

CA IDMS/DB set name

5E

EXBRESV

H

2

Reserved field

60

EXBFDBK

C

4

Allows you to set a feedback code (return code) from the exit program. By placing a value here (such as subschema control status) and by moving an 'X' to EXIT-SET-FEEDBACK, CA IDMS VSAM Transparency will display an error message on the job log including the feedback code you set.

60

EXBERID

C

1

Internal error id

61

EXBRTCD

C

1

Return code

62

EXBCOMP

C

1

Component code

63

EXBERCD

C

1

Error code

64

EXBRTYPE

C

6

Identifies the type of VSAM call issued. Use this field in conjunction with EXB-EXIT-FLAGS to determine what type of processing will be required. Valid values are:

  • 'GET '
  • 'PUT '
  • 'POINT '
  • 'ENDREQ'
  • 'ERASE '

6A

EXBOPT1

C

8

Further qualifies the request type:

6A

EXBDIR

C

1

Direct request

6B

EXBSEQ

C

1

Sequential request

6C

EXBSKP

C

1

Skip request

6D

EXBKGE

C

1

Key gt/eq request

6E

EXBGEN

C

1

Generic request

6F

FILLER

C

3

Filler

72

EXBOPT2

C

8

Further qualifies the request type:

72

EXBKEYA

C

1

Keyed access

73

EXBADDA

C

1

Address access

74

EXBBWD

C

1

Backward access

75

EXBLRD

C

1

Last record access

76

EXBUPD

C

1

Update access

77

EXBNSP

C

1

Set position

78

FILLER

C

2

Filler

7A

EXBFTYPE

C

8

Identifies the VSAM file type:

7A

EXBKSDS

C

1

KSDS

7B

EXBPATH

C

1

PATH

7C

EXBRRDS

C

1

RRDS

7D

EXBESDS

C

1

ESDS

7E

EXBBCES

C

1

Base cluster is ESDS

7F

EXBSET

C

1

Set is defined

80

EXBNVSAM

C

1

Data is in native VSAM

81

FILLER

C

1

Filler

82

EXBXFLAG

C

8

Exit flags that describe exit processing:

82

EXBEXIT

C

1

The first byte identifies the exit type:

  • Before = B
  • After = A

The next 5 bytes describe exit processing. Put an X in the byte to turn the character switch on. The default is blank.

83

EXBSKPA

C

1

Skip to after tells CA IDMS VSAM Transparency to invoke the after exit immediately after the before exit and bypass its processing.

84

EXBXRETN

C

1

Return immediately tells CA IDMS VSAM Transparency to return immediately to the user and bypass its processing.

85

EXBSETLN

C

1

Exit set record length tells CA IDMS VSAM Transparency the exit modified the length of the record in the buffer.

86

EXBSETAR

C

1

Exit set argument tells CA IDMS VSAM Transparency the exit set argument.

87

EXBSETFB

C

1

Exit set feedback tells CA IDMS VSAM Transparency the exit set the feedback code. CA IDMS VSAM Transparency will display a message with this feedback code to the job log.

88

FILLER

C

2

Filler

8A

FILLER

C

8

Filler

94

EXBSAVE

C

72

Exit save area

DC

FILLER

C

12

Filler