ATMP_OPTIONS parameter in DFHATOMPARMS container

The ATMP_OPTIONS parameter is the address of a double word containing 64 option bits that you use to indicate that your service routine is supplying optional containers with data such as a title for the Atom entry. The options string is mapped by the ATMP_OPTIONS_BITS DSECT.

The options bitmap to which ATMP_OPTIONS points is mapped in two ways: ATMP_OPTIONS_BITS and ATMP_OPTIONS_WORDS. ATMP_OPTIONS_BITS is a series of byte and bit definitions for use in languages that understand bit values. ATMP_OPTIONS_WORDS is a pair of fullword values, for use in COBOL, where bit values cannot be easily coded.

ATMP_OPTIONS_BITS

In ATMP_OPTIONS_BITS, the bit values that have meaning are in byte ATMP_OUTOPT_BYTE1, and they are as follows:

OPTTITLE: The service routine is using the DFHATOMTITLE container to return a character string to be used as the title for the entry.
OPTSUMMA: The service routine is using the DFHATOMSUMMARY container to return a character string to be used as the summary for the entry.
OPTAUTHOR: The service routine is using the DFHATOMAUTHOR container to return a character string to be used as the name of the author of the entry.
OPTAUTHEML: The service routine is using the DFHATOMEMAIL container to return a character string to be used as the e-mail address for the author of the entry.
OPTAUTHURI: The service routine is using the DFHATOMAUTHORURI container to return a character string to be used as the URI of a website associated with the author of the entry.
OPTCATEG: The service routine is using the DFHATOMCATEGORY container to return a character string to be used as a category term for the entry.

ATMP_OPTIONS_WORDS

ATMP_OPTIONS_WORDS contains these two fullword values:

ATMP_OPTIONS_IN: A fullword of input option values, which is not used.
ATMP_OPTIONS_OUT: A fullword in which to store output option values. The fullword values equivalent to the bit values in ATMP_OUTOPT_BYTE1 are specified in copybook DFH0W2CO. These values can be added together, as required, to produce a suitable bitmap value.

Copybook DFH0W2CO contains binary integers representing the value of the bits in ATMP_OUTOPT_BYTE1, for use in ATMP_OPTIONS_OUT, as follows:

OPTTITLE_NUM: Equivalent to OPTTITLE
OPTSUMMA_NUM: Equivalent to OPTSUMMA
OPTAUTHOR_NUM: Equivalent to OPTAUTHOR
OPTAUTHEML_NUM: Equivalent to OPTAUTHEML
OPTCATEG_NUM: Equivalent to OPTCATEG
OPTAUTHURI_NUM: Equivalent to OPTAUTHURI