Standard header

All macros which are new and, as a rule, all existing macros which which have been extended by the 31-bit interface make use of the standard header in order to identify their interface.

The standard header is an 8-byte field at the beginning of the data area containing the (standardized) interface name plus 4 bytes reserved for a return code. The standard header is generated and initialized, i.e. supplied with the valid values for UNIT, FUNCTION and VERSION, by the corresponding macro. When using an E-form macro with reference to the data area, the caller may have to initialize the standard header. Where required, details are given in the macro description.

Structure of the standard header:

Byte	Field contents and meaning
0 - 1	Name of the unit containing the requested function
2	Name of the function within the unit
3	Name of the version of the function
4	SUBCODE2 of the return code
5	SUBCODE1 of the return code
6 - 7	MAINCODE of the return code

Table 3: Standard header

The following list gives the standard return code values which apply to all macros:

SUB- CODE2	SUB- CODE1	MAIN- CODE	Meaning
X'00'	X'00'	X'0000'	The function has been performed without errors. There is no information in addition to the MAINCODE.
X'01'	X'00'	X'0000'	The function has been performed without errors. No further action was required.
X'00'	X'01'	X'FFFF'	The requested function is not supported (incorrect entry for UNIT or FUNCTION in the standard header). Unrecoverable error.
X'00'	X'02'	X'FFFF'	The requested function is not available. Unrecoverable error.
X'00'	X'03'	X'FFFF'	The specified version of the interface is not supported (incorrect entry for VERSION in the standard header). Unrecoverable error.
X'00'	X'04'	X'FFFF'	Data area is not aligned on a word boundary.
X'00'	X'41'	X'FFFF'	The subsystem is not present and must be explicitly generated.

Table 4: Standard return codes

SUB- CODE2	SUB- CODE1	MAIN- CODE	Meaning
X'00'	X'42'	X'FFFF'	The calling task is not connected to this interface; the connection must be explicitly established.
X'00'	X'81'	X'FFFF'	The subsystem is currently not available.
X'00'	X'82'	X'FFFF'	The subsystem is in the DELETE or HOLD state.

Table 4: Standard return codes

MAINCODE indicates the result of function execution. SUBCODE1 qualifies MAINCODE. SUBCODE2 further qualifies the error by means of error classes or contains additional diagnostic information.
With all new macros, the return code should be supplied exclusively in the standard header. Some macro interfaces allow the return code to be passed in register R15, either as an alternative or in addition to being supplied in the standard header. The return code field should be initially set to X'FFFFFFFF' in order to permit checking whether a return code has been transferred to the standard header or not.

Example: generation of standard header

           WROUT    START
           PRINT NOGEN
           BALR  3,0
           USING *,3
  WROUT    AMODE ANY
  WROUT    RMODE ANY
           GPARMOD 31
1                 *,MACRO: GPARMOD, VERSION: VER121
           PRINT GEN
           WROUT OUTPUT,STOP
1          ##SPASS S0002S,S0002D                                     A312
2          CNOP  0,4
2          BAS   1,S0002S           ADDRESS AND SKIP PARAMS
1 S0002D     DS 0F                                                   A340
1          FHDR  UNIT=36,FUNCT=17,VERS=2
2          DS    0A
2          DS    0XL8                GENERAL OPERAND LIST HEADER
2          DC    AL2(36)             FUNCTION UNIT NUMBER
2          DC    AL1(17)             FUNCTION NUMBER
2          DC    AL1(2)              FUNCTION INTERFACE VERSION NUMBER
2          DC    X'FFFFFFFF'          Returncode is virgin
1 *
1          DC    AL4(STOP)                ERROR ADDRESS
1          DC    AL4(OUTPUT)              MESSAGE AREA ADDRESS
  *        :

3.8

Macro Command Language Processor macros The Macro Command Language Processor (MCLP) allows (system) commands to be entered without exiting the program mode. The macro CMD is used to invoke the MCLP (with SVC 5816) and to communicate the command name and operands. The MCLP carries out a syntax check before branching to the actual command processing routine itself. After the command has been executed, the program is resumed. Some of the commands which can be invoked will terminate the calling program (see table 12 (CMD - Call command)). The calling program is also terminated if (user-specific) commands defined using SDF-A and implemented by command procedures are called. In addition to SDF commands, ISP commands may also be invoked. Input errors in SDF command names may be corrected in interactive mode. Some of the BS2000 commands contained in the system syntax file of BS2000 OSD/BC cannot be called via the CMD macro, see table 11 (CMD - Call command). Some of the commands have own macros. The following table compares these macros with the corresponding commands (macros described in the appendix are not included):

Macro	Command	Function
CDUMP2	CREATE-DUMP	Generate dump
CHKPRV	SHOW-PRIVILEGE	Query own job privileges
ENTER	ENTER-JOB	Submit a job
LGOFF	EXIT-JOB	Terminate job
MSGSHOW	SHOW-MSG-FILE-ASSIGNMENT	Output information on system or t taskspecific message files
MSGSINIT	MODIFY-MSG-FILE-ASSIGNMENT	Lock message file or add message file to message system
MSGSMOD	MODIFY-MSG-FILE-ASSIGNMENT	Lock message file or add message file to message system
NKDINF	SHOW-DEVICE-DEPOT SHOW-DEVICE-CONFIGURATION SHOW-DEVICE-STATUS SHOW-DISK-DEFAULTS SHOW-DISK-STATUS SHOW-MOUNT-PARAMETERS SHOW-RESOURCE-ALLOCATION SHOW-RESOURCE-REQUEST SHOW-TAPE-STATUS	Output information on the allocation and availability status of configuration and mounted volumes
NSIINF	SHOW-SYSTEM-INFORMATION	Output system information
NSIOPT	SHOW-SYSTEM-PARAMETERS	Output system parameters
RDUID	SHOW-JOB-STATUS	Read user ID
SINF	SHOW-SYSTEM-INFORMATION SHOW-SYSTEM-PARAMETERS	Output system information and system parameters
SRMUINF	SHOW-USER-ATTRIBUTES	Output information from user catalog
STAMCE	SHOW-MASTER-CATALOG-ENTRY	Output MRSCAT entries
	SHOW-PUBSET-PARAMETERS	Output pubset information
SWITCH	MODIFY-JOB-SWITCHES	Set job switches
	MODIFY-USER-SWITCHES	Set user switches
	SHOW-JOB-SWITCHES	Query job switches
	SHOW-USER-SWITCHES	Query user switches
SYSFL	ASSIGN-SYSDTA ASSIGN-SYSLST ASSIGN-SYSOUT REMOVE-TASKLIB SET-TASKLIB	Assign system files
SYSTA	SHOW-SYSTEM-FILE-ASSIGNMENTS	Output system file assignments
TCHNG	MODIFY-TERMINAL-OPTIONS	Modify terminal attributes