REQUEST=FREE option of IEFPRMLB

The IEFPRMLB macro is written as follows:

The parameters are explained as follows:

REQUEST=FREE

A required parameter. REQUEST=FREE unallocates the logical parmlib data set concatenation.

,RETMSG=NO

,RETMSG=YES

An optional parameter, that indicates whether or not messages are to be returned to the caller in an input message buffer. The default is RETMSG=NO.

,RETMSG=NO

specifies that messages generated during IEFPRMLB processing should not be returned to the caller in the input message buffer (MSGBUF). Messages generated during IEFPRMLB processing will be issued to the console specified by the input console id or will be issued with Route Code 11 (Programmer Information) and descriptor code 4 (System Status) if no console id is input.

,RETMSG=YES

specifies that messages generated during IEFPRMLB processing should be returned to the caller in the input message buffer (MSGBUF). Note that the only messages capable of being returned are those issued by MVS™ Allocation and SMS. Also, only error messages (severity level 8 and higher) are returned with RETMSG=YES.

,CONSOLID=consolid

,CONSOLID=NOCONSID

An optional input parameter when RETMSG=YES is not specified, that contains the id of the console which originated this request and may be provided if messages are to be issued. The default is NOCONSID.

To code: Specify the RS-type address, or address in register (2)-(12), of a 4-character field.

,CART=cart

,CART=NOCART

An optional input parameter when RETMSG=YES is not specified, that contains the Command And Response Token. The default is NOCART.

To code: Specify the RS-type address, or address in register (2)-(12), of an 8-character field.

,MSGBUF=msgbuf

,MSGBUF=NOMSGBUF

A required input parameter when RETMSG=YES is specified, that is the area into which all messages generated during IEFPRMLB processing are to be placed. The format of each message returned in the buffer is mapped by IEFZPMAP and is compatible with WTO format requirements for the TEXT keyword. There may be more than one message in the buffer. A 4K buffer is recommended. Messages are placed contiguously into the buffer in 256-byte message elements. If the input buffer is not large enough to contain all the generated messages, those messages that will fit are returned in the buffer in the order they are generated. If the message buffer is filled, an indicator (PRM_Msg_Buffer_Full) will be returned to indicate the buffer is full and, therefore, may not contain all messages. PRM_Message_Count will contain the number of messages in the buffer. See DSECT PRM_Message_Buffer in IEFZPMAP for a complete mapping of the message buffer.

The caller must fill in the following fields in the message buffer (DSECT PRM_Message_Buffer):

• PRM_Msg_Buffer_Size set to the size of the buffer (including the header)
• All other fields set to zero

The default is NOMSGBUF.

To code: Specify the RS-type address, or address in register (2)-(12), of a character field.

,DDNAME=ddname

A required input parameter, that is the DDname associated with the logical parmlib. The logical parmlib data set concatenation will be unallocated. The DDname originally input to or returned by the invocation of IEFPRMLB REQUEST=ALLOCATE should be input. If the logical parmlib is open when IEFPRMLB is invoked with REQUEST=FREE, the unallocation will fail.

To code: Specify the RS-type address, or address in register (2)-(12), of an 8-character field.

,CALLERNAME=callername

A required input parameter, that is the EBCDIC caller's name which is to be used in messages, symptom records and other diagnostic areas as necessary during IEFPRMLB processing. Initial characters A-I and SYS are reserved for IBM® use.

The suggested callername definition is 'ProgramName || ServiceLevel'

Example:

IEF761I jjobname [procstep] stepname ddname callername
        DD IS ALREADY ALLOCATED AND WILL BE USED BY
        THIS TASK

To code: Specify the RS-type address, or address in register (2)-(12), of a 16-character field.

,RETCODE=retcode

An optional output parameter into which the return code is to be copied from GPR 15.

To code: Specify the RS-type address of a fullword field, or register (2)-(12).

,RSNCODE=rsncode

An optional output parameter into which the reason code is to be copied from GPR 0.

To code: Specify the RS-type address of a fullword field, or register (2)-(12).

,PLISTVER=IMPLIED_VERSION

,PLISTVER=MAX

,PLISTVER=plistver

An optional input parameter that specifies the version of the macro. PLISTVER determines which parameter list the system generates. PLISTVER is an optional input parameter on all forms of the macro, including the list form. When using PLISTVER, specify it on all macro forms used for a request and with the same value on all of the macro forms. The values are:

• IMPLIED_VERSION, which is the lowest version that allows all parameters specified on the request to be processed. If you omit the PLISTVER parameter, IMPLIED_VERSION is the default.
• MAX, if you want the parameter list to be the largest size currently possible. This size might grow from release to release and affect the amount of storage that your program needs.

  If you can tolerate the size change, IBM recommends that you always specify PLISTVER=MAX on the list form of the macro. Specifying MAX ensures that the list-form parameter list is always long enough to hold all the parameters you might specify on the execute form; in this way, MAX ensures that the parameter list does not overwrite nearby storage.

• 0, if you use the currently available parameters.

To code: Specify one of the following:

• IMPLIED_VERSION
• MAX
• A decimal value of 0

,MF=S

,MF=(L,list addr)

,MF=(L,list addr,attr)

,MF=(L,list addr,0D)

,MF=(E,list addr)

,MF=(E,list addr,COMPLETE)

An optional input parameter that specifies the macro form.

Use MF=S to specify the standard form of the macro, which builds an inline parameter list and generates the macro invocation to transfer control to the service. MF=S is the default.

Use MF=L to specify the list form of the macro. Use the list form together with the execute form of the macro for applications that require reentrant code. The list form defines an area of storage that the execute form uses to store the parameters. Only the PLISTVER parameter may be coded with the list form of the macro.

Use MF=E to specify the execute form of the macro. Use the execute form together with the list form of the macro for applications that require reentrant code. The execute form of the macro stores the parameters into the storage area defined by the list form, and generates the macro invocation to transfer control to the service.

,list addr

The name of a storage area to contain the parameters. For MF=S, MF=E, and MF=M, this can be an RS-type address or an address in register (1)-(12).

,attr

An optional 1- to 60-character input string, which can contain any value that is valid on an assembler DS pseudo-op. You can use this parameter to force boundary alignment of the parameter list. If you do not code attr, the system provides a value of 0D, which forces the parameter list to a doubleword boundary.

,COMPLETE

Specifies that the system is to check for required parameters and supply defaults for omitted optional parameters.

None.

See the return codes in under REQUEST=ALLOCATE option of IEFPRMLB.

None.