CEE3RPH—Set report heading

CEE3RPH sets the heading displayed at the top of the storage or options report generated when you specify the RPTSTG(ON) or RPTOPTS(ON) runtime options. For examples of these reports, see z/OS Language Environment Debugging Guide.


Syntax

>>-CEE3RPH--(--report_heading--,--fc--)------------------------><

report_heading (input)

An 80-character fixed-length string. report_heading sets the identifying character string displayed at the top of the storage or options report. Language Environment uses only the first 79 bytes of report_heading; the last byte is ignored. report_heading can contain DBCS characters surrounded by X'0E' (shift-out) and X'0F' (shift-in).

fc (output)

A 12-byte feedback code, optional in some languages, that indicates the result of this service. If you choose to omit this parameter, refer to Invoking callable services for the appropriate syntax to indicate that the feedback code was omitted.

The following symbolic conditions can result from this service:

Code	Severity	Message number	Message text
CEE000	0	—	The service completed successfully.
CEE3JK	0	3700	The storage and options report heading replaced a previous heading.

Usage notes

PL/I considerations—CEE3RPH is designed to provide an equivalent function to the special PL/I variable PLIXHD.
z/OS UNIX considerations—CEE3RPH applies to the enclave.

For more information

See RPTSTG for more information about the RPTSTG runtime option.
See RPTOPTS for more information about the RPTOPTS runtime option.
See PL/I for MVS™ & VM Programming Guide for further information about PLIXHD.

Examples

Following is an example of CEE3RPH called by C/C++.

/*Module/File Name: EDC3RPH   */

#pragma runopts(RPTOPTS(ON))
#include <string.h>
#include <leawi.h>
#include <ceeedcct.h>

int main(void) {

   _CHAR80   heading;

   /* initialize heading to blanks and then set the */
   /* heading */
   memset(heading,' ',80);
   memcpy(heading,"User Defined Report Heading",27);

   /* set the report heading...do not need to check */
   /* feedback token because all return codes are */
   /* successful */
   CEE3RPH(heading,NULL);
  /* .
     .
     . */
}

Following is an example of CEE3RPH called by COBOL.

CBL LIB,QUOTE
      *Module/File Name: IGZT3RPH
      *************************************************
      **                                             **
      ** CBL3RPH - Call CEE3RPH to set report heading**
      **                                             **
      ** In this example, a call is made to CEE3RPH  **
      ** to set the report heading that appears at   **
      ** the top of each page of the options report  **
      ** (generated by RPTOPTS) and storage report   **
      ** (generated by RPTSTG).                      **
      **                                             **
      *************************************************
       IDENTIFICATION DIVISION.
       PROGRAM-ID. CBL3RPH.

       DATA DIVISION.
       WORKING-STORAGE SECTION.
       01  RPTHEAD                 PIC X(80).
       01  FC.
           02  Condition-Token-Value.
           COPY  CEEIGZCT.
               03  Case-1-Condition-ID.
                   04  Severity    PIC S9(4) BINARY.
                   04  Msg-No      PIC S9(4) BINARY.
               03  Case-2-Condition-ID
                         REDEFINES Case-1-Condition-ID.
                   04  Class-Code  PIC S9(4) BINARY.
                   04  Cause-Code  PIC S9(4) BINARY.
               03  Case-Sev-Ctl    PIC X.
               03  Facility-ID     PIC XXX.
           02  I-S-Info            PIC S9(9) BINARY.

       PROCEDURE DIVISION.

      *************************************************
      ** Specify user-defined report heading via CEE3RPH
      *************************************************
       PARA-CBL3RPH.
           MOVE "My options and storage reports heading"
               TO RPTHEAD.
           CALL "CEE3RPH" USING RPTHEAD, FC.
           IF NOT CEE000 of FC  THEN
               DISPLAY "CEE3RPH failed with msg "
                   Msg-No of FC UPON CONSOLE
               STOP RUN
           END-IF.

           GOBACK.

Following is an example of CEE3RPH called by PL/I.

*PROCESS MACRO;
 /* Module/File Name: IBM3RPH                        */
 /****************************************************/
 /**                                                **/
 /** Function: CEE3RPH - set report heading         **/
 /**                                                **/
 /****************************************************/
 PLI3RPH: PROC OPTIONS(MAIN);

    %INCLUDE  CEEIBMAW;
    %INCLUDE  CEEIBMCT;

    DCL RPTHEAD  CHAR(80);
    DCL 01 FC,                     /* Feedback token */
           03 MsgSev    REAL FIXED BINARY(15,0),
           03 MsgNo     REAL FIXED BINARY(15,0),
           03 Flags,
              05 Case      BIT(2),
              05 Severity  BIT(3),
              05 Control   BIT(3),
           03 FacID     CHAR(3),      /* Facility ID */
           03 ISI   /* Instance-Specific Information */
                        REAL FIXED BINARY(31,0);

    /* Define report heading                         */
    RPTHEAD = 'My storage report heading';

    /* Set report heading in call to CEE3RPH         */
    CALL CEE3RPH ( RPTHEAD, FC );

    IF  FBCHECK( FC, CEE000)  THEN  DO;
       PUT SKIP LIST( 'Report heading now set to "'
          || RPTHEAD || '"' );
       END;
    ELSE  DO;
       DISPLAY( 'CEE3RPH failed with msg '
          || FC.MsgNo );
       STOP;
       END;

 END PLI3RPH;