The communications area at INSTALL for bridge facility virtual terminals

The communications area is mapped by the DSECT for the assembler version of DFHZATDX or DFHZATDY, which are supplied in CICSTS55.CICS.SDFHMAC.

Figure 1. Autoinstall control program's communications area at INSTALL

 -----------------------------------------------------------------------
* Install Bridge Facility                        - Function 15 & 17          
*---------------------------------------------------------------------* 
INSTALL_BRFAC_COMMAREA       DSECT       Install Parameter List     
INSTALL_BRFAC_STANDARD       DS  F       Standard field             
                             ORG INSTALL_BRFAC_STANDARD           
INSTALL_BRFAC_EXIT_FUNCTION  DS  XL1     Install type                 
INSTALL_LINK_BRFAC            EQU X'0F' Install Link Brfacility  
INSTALL_START_BRFAC           EQU X'11' Install Start Brfacility 
INSTALL_BRFAC_EXIT_COMPONENT DS CL2      Component ID 'BR'            
                             DS  CL1     Reserved                     
                             ORG ,                                  
INSTALL_BRFAC_NETNAME_PTR    DS  A       Pointer to input netname           
INSTALL_BRFAC_SELECTED_PTR   DS  A       Pointer to return fields     
INSTALL_BRFAC_TERMID_PTR     DS  A       Pointer to input termid   
                             DS  A       Reserved                     
                             DS  A       Reserved                     
                             DS  A       Reserved                     
INSTALL_BRFAC_SELECTED_PARMS DSECT ,                               
                             DS  CL8     Reserved                     
SELECTED_BRFAC_TERMID        DS  CL4     Selected termid              
SELECTED_BRFAC_RETURN_CODE   DS  B       Selected return              
SELECTED_BRFAC_NETNAME  DS  CL8     Selected netname             
*                                                                       
*-----------------------------------------------------------------------*

INSTALL_BRFAC_STANDARD

A fullword input field containing the following information:

INSTALL_BRFAC_EXIT_FUNCTION

A 1-byte field that indicates the type of resource being installed. For install of bridge facility virtual terminals. The equated values are:

INSTALL_LINK_BRFAC (X'0F'): The autoinstall program was called during installation of a bridge facility to be used by the link3270 bridge.
INSTALL_START_BRFAC (X'11'): The autoinstall program was called during installation of a bridge facility to be used by the START bridge.

INSTALL_BRFAC_EXIT_COMPONENT

A 2-byte component code, which is set to ‘BR'.

INSTALL_BRFAC_NETNAME_PTR

A fullword pointer to an 8-character field containing the netname of the bridge facility. This is either the value specified by the client or the value generated by CICS® if the client specifies BRIHNN-DEFAULT (the default value).

INSTALL_BRFAC_SELECTED_PTR

A fullword pointer to the return fields. The output fields, for use by your program, are:

SELECTED_BRFAC_TERMID

A 4-character field used to specify the name by which the virtual terminal will be known to CICS. If the name is less than 4 characters long, it must be padded with trailing blanks. For a list of the characters you can use in terminal names, see TERMINAL attributes. You can copy the name in INSTALL_BRFAC_TERMID_PTR, or set a new value.

SELECTED_BRFAC_RETURN_CODE

The 1-character return code field. The equated values are:

RETURN_OK (X'00'): Install the virtual terminal. This is the default value. Your user program must return this value if the resource is to be autoinstalled.
REJECT (X'01'): Do not install the virtual terminal.

SELECTED_BRFAC_NETNAME

An 8-character field used to specify the netname of the bridge facility. If the name is less than 8 characters long, it must be padded with trailing blanks. You can copy the name in INSTALL_BRFAC_NETNAME_PTR, or set a new value.

INSTALL_BRFAC_TERMID_PTR

A fullword pointer to a 4-character input field containing the TERMID passed to the CICS autoinstall function (that is, the supplied name).