z/OS DFSMS OAM Application Programmer's Reference
Previous topic | Next topic | Contents | Contact z/OS | Library | PDF


Getting the code right

z/OS DFSMS OAM Application Programmer's Reference
SC23-6865-00

The following list summarizes general guidelines for coding the OSREQ macro:
  • The OSREQ macro uses only one positional parameter: function. This parameter is always required.
  • To invoke OAM functions, the OSREQ macro execute form is always necessary. It must be coded in one of the following ways:
    • MF=(E,parameter_list)
    • MF=(E,parameter_list,COMPLETE)
    where parameter_list identifies a parameter list area generated using the list form of the OSREQ macro. That area may have been modified previously by the modify form of the OSREQ macro (MF=(M,parameter_list)).
    Note: Use either the actual generated list or a copy of it.

    The execute form updates the parameter list area with any parameter values supplied and calls OAM.

    When you specify COMPLETE, the parameter list is zeroed, and nonzero defaults are set before any supplied parameter values are applied.

  • Some parameters must be supplied from one or more of the following sources:
    • List form
    • Modify form
    • Execute form

    Parameters must be encoded at least once and must be provided for every invocation of the macro; however, it may not be necessary to explicitly code each parameter for each invocation within an application.

  • The following keyword parameters are optional for all OSREQ macro functions, but if specified, are used by all functions:
    • MSGAREA
    • RETCODE
    • REACODE
  • The object name that is specified in the name keywords must be fully qualified. Fully qualified names are described in the explanations of the COLLECTN and NAME parameters. See OSREQ keyword parameter descriptions for descriptions of these and all other OSREQ function parameters.
    Note: The name parameter does not have to be fully qualified when it is used with the QUERY function. Generic names in which the lowest level qualifier of the object name may end in an asterisk are also acceptable.
  • Keyword parameters that are not specified in the syntax diagram for a function may be included with that function. The keyword value pointers are established or updated, but the keyword values that are not related to the function are ignored.

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014