>>-+--------+--$DEST--DEST--=--+-label------+------------------->
   '-symbol-'                  '-(--R--n--)-'   

>--+-----------------------+--+---------------------------+----->
   |           .-SCHAR---. |  '-,ERRET--=--+-label------+-'   
   '-,CONV--=--+-ECHAR---+-'               '-(--R--n--)-'     
               +-EBINARY-+                                    
               '-SBINARY-'                                    

>--+-----------------------+--+----------------------+---------->
   |               .-NO--. |  |              .-NO--. |   
   '-,EXPLICIT--=--+-YES-+-'  '-,GENERIC--=--+-YES-+-'   

                                             .-NO--.   
>--+---------------------------+--,DLMFAIL=--+-YES-+------------>
   |               .-HONORED-. |                       
   '-,NODENAME--=--+-IGNORED-+-'                       

>--+-----------------------+--,LEN--=--+-value--+--------------->
   |             .-NO----. |           '-equate-'   
   '-,IPFORM--=--+-YES---+-'                        
                 +-long--+                          
                 '-short-'                          

>--,NODE--=--+-label------+--+---------------------------+------>
             '-(--R--n--)-'  '-,OKRET--=--+-label------+-'   
                                          '-(--R--n--)-'     

>--+----------------+--+----------------------+----------------->
   '-,PARM--=--addr-'  |              .-NO--. |   
                       '-,PRIMARY--=--+-YES-+-'   

>--+----------------------+--+----------------------+----------->
   |              .-YES-. |  |              .-YES-. |   
   '-,RMTPOOL--=--+-NO--+-'  '-,SUPPRES--=--+-NO--+-'   

>--+-----------------+--+---------------------------+----------><
   '-,USER--=--field-'  |               .-HONORED-. |   
                        '-,SHOWUSER--=--+-IGNORED-+-'   

DEST=

Specifies the address of the symbolic destination for which a binary route code is obtained or the address of an area that contains a binary route code which is to be replaced by a symbolic destination. If register notation is used, the destination address must be loaded into the designated register before the execution of this macro instruction.

Note: If CONV=EBINARY was specified, the minimum length required for the DEST field is 16 bytes. If CONV=SBINARY, the length of the DEST field must be at least 17 bytes, unless the destination is at the local node and SUPPRES=YES was specified, in which case the minimum length is 16.

,CONV=

Specifies the type of conversion that is required as follows:

SCHAR

The symbolic destination specified by DEST= is to be converted to a binary value and returned in R1. The DEST value can be explicit (for example, LOCAL or NnnnnRnnnn) or a DESTID value.

ECHAR

The symbolic destination specified by DEST= is to be converted to a binary value and returned in R1. The DEST value must be explicit (for example, NnnnnRnnnn).

SBINARY

Specifies a binary route code is to be converted to a symbolic destination. If only a single DESTID matches, it is converted and returned. If no DESTIDs or more than one DESTID matches, then the explicit form (for example, NnnnnRnnnn or LOCAL) is returned. The DEST field must be at least 17 bytes in length, unless the destination is at the local node, and SUPPRES=YES was specified, in which case the minimum length is 16 bytes.

EBINARY

Specifies a binary route code is to be converted to a symbolic destination. Only the explicit forms are checked (for example, NnnnnRnnnn or LOCAL) and returned. The DEST field must be at least 16 bytes in length.

ERRET=

Specifies a location to which control is returned if the specified destination is not valid.

LEN=

Specifies the length or an equated value of the length of the symbolic destination.

NODE=

Specifies the address or a register that contains the address of a halfword field that contains the default node number used to construct the binary route code. If register notation is used, the node number is loaded into the designated register before the execution of this macro instruction. NODE= is required if you code CONV=SCHAR or CONV=ECHAR.

EXPLICIT =

Specifies whether (YES) or not (NO) this $DEST macro call ignores the DESTDEF initialization statement that can affect how job and SYSOUT destinations are processed. EXPLICIT=NO is the default.

If you specify EXPLICIT=YES, the Ndest=, R|RM|RMTdest=, and Udest= parameters on the DESTDEF initialization statement provide only their default values on this $DEST macro call.

GENERIC=

Specifies whether or not generic userids can be used.

YES

Specifies that the last character of a userid can be an asterisk (*).

NO

Specifies that an * is not a valid character in a userid.

This parameter is only valid when CONV=SCHAR and a userid field are specified.

NODENAME=

Specifies whether or not DESTDEF NODENAME will affect $DEST processing.

Note: This parameter is only valid when CONV= SCHAR or ECHAR is specified.

HONORED

The setting of DESTDEF NODENAME will affect $DEST processing. If DESTDEF NODENAME=REQUIRED, then the destination must be either a valid destid or a userid explicitly prefixed with a node. If DESTDEF NODENAME=OPTIONAL, then userids do not require explicit node qualification.

IGNORED

The setting of DESTDEF NODENAME will not affect $DEST processing.

The default value for DESTDEF NODENAME is HONORED.

DLMFAIL=

Determines whether delimiters within the destination are to be honored (NO) or considered an error (YES). If yes is specified, the destination passed in must be followed by trailing blanks or nulls. The default is DLMFAIL=NO.

IPFORM=

This parameter determines what form, if any IP-format destination is valid.

Note: This parameter is only valid when CONV= SCHAR or ECHAR is specified.

IPFORM=NO (Default)

Specifies that JES2 allows no form of IP-format destination.

IPFORM=YES

Specifies that the input destination can be in IP format, for example: 'node.IP:-address' or 'IP:ip-address'. You must also specify USER=.

IPFORM=LONG

Specifies that the input destination can be in IP format, for example: 'node.IP:-address' or 'IP:ip-address'. You must also specify USER=.

IPFORM=SHORT

Specifies that input destination of <IP> is allowed. You must also specify USER=.

OKRET=

Specifies the address of the routine that is to receive control when JES2 passes back a zero return code.

PARM=

Specifies the address of storage to be used for a parameter list for the $DEST service, which will be filled in automatically by the macro. The default for this parameter is 12(R13), that is the address contained in register 13 plus 12 bytes.

PRIMARY=

 

YES

Causes JES2 to return the primary DESTID instead of an explicit route code if there are multiple route codes which match the binary input. This parameter takes effect only when you code CONV=SBINARY.

NO

Causes CONV=SBINARY to work as described above.

RMTPOOL=

 

YES

Specifies that JES2 should change the destination to reflect remote pooling.

NO

Remote pooling not in effect.

SUPPRES =

Specifies whether or not destinations at the local node are converted and displayed differently from destinations at other nodes.

YES

Specifies that a first-level destination of the local node name is not included in the final destination.

When converting from binary input to character at node 1, a destination of 0001 0005 is resolved as R5. However, a destination of 0002 0005 is resolved as N2.R5 because N2 is not the local node.

When converting from character input to binary at node 1, a destination of N1.U5 will resolve to a destination of 0000 0005, with no userid placed in the area specified by USER=.

When converting from character input to binary at node 1, N2.U5 resolves to 0002 0000 with the characters 'U5' placed in the area specified by USER=, because N2 is not the local node.

SUPPRES=YES is the default.

NO

Specifies that a first-level destination is included in the final destination.

When converting from binary input to character, a destination of 0001 0005 resolves as N1.R5.

When converting from character input to binary, a destination of N1.U5 resolves to a binary destination of 0001 0000 with the characters 'U5' placed in the area specified by USER=.

USER=

If you code CONV=SBINARY or CONV=EBINARY, you can supply a userid for the field to be placed in the output area.

If you code CONV=SCHAR or CONV=ECHAR, the conversion routine will separate the userid from the route code, and place the userid in the field.

SHOWUSER=

Specifies whether or not DESTDEF SHOWUSER will be honored during $DEST processing.

HONORED

The setting of DESTDEF SHOWUSER will be honored during $DEST processing

IGNORED

The setting of DESTDEF SHOWUSER will be ignored during $DEST processing.

The default value for DESTDEF SHOWUSER is HONORED.

• All environments.
• MVS™ WAIT or $WAIT cannot occur.
• Callers in AR ASC mode are supported. However, all data areas passed must be addressable in primary ASC mode.