z/OS MVS Programming: Authorized Assembler Services Reference SET-WTO
Previous topic | Next topic | Contents | Contact z/OS | Library | PDF


UCBPIN - Execute form

z/OS MVS Programming: Authorized Assembler Services Reference SET-WTO
SA23-1375-00

Use the execute form of the UCBPIN macro together with the list form for applications that require reentrant code. The execute form of the macro stores the parameters into the storage area defined by the list form.

Syntax

The execute form of the UCBPIN macro is written as follows:

Syntax Description
   
   name name: Symbol. Begin name in column 1.
   
One or more blanks must precede UCBPIN
   
UCBPIN  
   
One or more blanks must follow UCBPIN
   
PIN  
UNPIN Note: See the table following this diagram for valid parameter combinations.
   
   ,PTOKEN=ptoken addr ptoken addr: RS-type address or register (2) - (12).
   
   ,UCBPTR=ucbptr addr ucbptr addr: RS-type address or register (2) - (12).
   
   ,TEXT=text addr text addr: RX-type address
   
   ,LASTING  
   
   ,IOCTOKEN=ioctoken addr ioctoken addr: RX-type address or register (2) - (12).
   
   ,TO=xto xto: RS-type address or register (2) - (12).
   
   ,FROM=xfrom xfrom: RS-type address or register (2) - (12).
   
   ,RETCODE=retcode addr retcode addr: RX-type address or register (2) - (12).
   
   ,RSNCODE=rsncode addr rsncode addr: RX-type address or register (2) - (12).
   
   ,LINKAGE=SYSTEM Default: SYSTEM
   ,LINKAGE=BRANCH  
   
   ,RETCODE=retcode addr retcode addr: RX-type address or register (2) - (12).
   
   ,RSNCODE=rsncode addr rsncode addr: RX-type address or register (2) - (12).
   
   ,LINKAGE=SYSTEM Default: SYSTEM
   ,LINKAGE=BRANCH  
   
,MF=(E,list addr) list addr: RX-type address or register (2) - (12).
,MF=(E,list addr,COMPLETE) Default: COMPLETE
   

The following table shows how other parameters may be used with PIN and UNPIN.

Parameters PIN UNPIN
PTOKEN required required
UCBPTR required not valid
TEXT required not valid
LASTING optional not valid
IOCTOKEN optional not valid
LINKAGE optional optional
RETCODE optional optional
RSNCODE optional optional
MF required required
TO not valid not valid
FROM not valid not valid

Parameters

The parameters are explained under the standard form of the UCBPIN macro with the following exceptions:

,MF=(E,list addr)
,MF=(E,list addr,COMPLETE)
Specifies the execute form of the UCBPIN macro.

The list addr parameter specifies the address of the storage area for the parameter list. COMPLETE specifies that the system is to check for required parameters and supply defaults for optional parameters that were not specified.

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014