CA IDMS VSAM Transparency User Exits › Assembler User Exit Program › Macros

Macros

There are three macros supplied with CA IDMS/DB that can be used in Assembler:

#GETSTG

#GETSTG acquires variable storage from a storage pool or obtains the address of a previously acquired storage area. Syntax is shown below:

{label} #GETSTG TYPE=(USER,SHORT),PLIST=*,
                LEN=stg-len,INIT=init-val,
                ADDR=(R1),ERROR=error-label

• TYPE is used to indicate the type of storage acquired.
• PLIST indicates where the 6-fullword #GETSTG parameter list will be built. * indicates that the list will be built inline.
• LEN specifies the size, in bytes, of a new storage area. Stg-len is an absolute expression.
• INIT specifies an initial value for the storage. Init-val is an absolute expression of the initial value.
• ADDR=(R1) specifies where CA IDMS/DC will return the address of the acquired storage.
• ERROR specifies the symbolic name of the routine to which control should be returned to in case of an error.

  Note: If the user exit is acquiring storage, a #FREESTG must be done before the end of the program.

#FREESTG

#FREESTG requests CA IDMS/DC to release a block of variable storage. Syntax is shown below:

{label} #FREESTG ADDR=(R1)

ADDR=(R1) specifies the address of the storage area to be released.

#MOPT

#MOPT sets up the options for the issuing module. The only code that should appear prior to the #MOPT is 'TITLE', COMMENTS, or source macro definitions. Syntax is shown below:

#MOPT   ENV=USER

ENV=USER specifies that this is a DC/UCF user module.

Note: The #MOPT macro also equates register 0 through register 15 to R0 through R15.

For a complete definition of these macros see CA IDMS DML Reference Guide for Assembler.