Before calling ASASYMBM to substitute text for a symbol, the caller
must provide the symbol pattern and its length, an output buffer and
its length, and an area in which to place the return code from ASASYMBM.
The caller can optionally provide a symbol table and a time stamp.
The caller
must code the following fields
in the ASASYMBP mapping macro:
- Field
- Description
- SYMBPPATTERN@
- Specifies the address of the input character string (pattern)
that contains symbols to be resolved.
- SYMBPPATTERNLENGTH
- Specifies the length of the input pattern specified in the PATTERN@
field.
- SYMBPTARGET@
- Specifies the address of the buffer that is to contain the output
from ASASYMBM (the results of the symbolic substitution).
- SYMBPTARGETLENGTH@
- Specifies the address of a fullword that:
- On input, contains the length of the output buffer specified in
the TARGET@ field
- On output, contains the length of the substituted text within
the output buffer.
- SYMBPRETURNCODE@
- Specifies the address of a fullword that is to contain the return
code from ASASYMBM.
Before calling ASASYMBM, you can
optionally code
the following fields in the ASASYMBP mapping macro:
- Field
- Description
- SYMBPSYMBOLTABLE@
- Specifies the address of a symbol table mapped by the SYMBT
DSECT. Specify an address in this field if you want to do one or both
of the following:
- Provide symbols in addition to the system symbols that are defined
to the system, or override the system symbols that are defined to
the system.
- Use additional functions of ASASYMBM, which are described in Providing a symbol table to ASASYMBM.
Otherwise, specify an address of 0 in this field.
- SYMBPTIMESTAMP@
- Specifies the address of an eight-character area that contains
the time stamp to be used. The format of the time stamp is the same
as the format of the system time of day clock (in other words, the
format of the value returned by the STCK instruction). Specify an
address of zero to have the system use the current time stamp when
substituting for system symbols that relate to the time or date. By
default, the input time stamp is Greenwich Mean Time. Use the TIMESTAMPISLOCAL
or TIMESTAMPISSTCK bits to indicate that the input time stamp is local,
or obtained from the system time of day clock.
After the call to ASASYMBM, the caller can examine the following:
- The fullword pointed to by the SYMBPRETURNCODE@ field
- The fullword pointed to by the SYMBPTARGETLENGTH@ field
- The area pointed to by the SYMBPTARGET@ field.