Retrieve Power Schedule Entry (RTVPWRSCDE)

Where allowed to run: Compiled CL program or interpreted REXX (*BPGM *IPGM *BREXX *IREXX)
Threadsafe: No
Parameters
Examples
Error messages

The Retrieve Power On/Off Schedule Entry (RTVPWRSCDE) command retrieves a power on/off schedule entry value for use in a CL or REXX program. The value is returned (copied) to the specified CL variable in the program.

Restrictions:

  1. To use this command, you must have use (*USE) authority to the Display Power On/Off Schedule (DSPPWRSCD) command.
Top

Parameters

Keyword Description Choices Notes
DAY Day Date, *TODAY, *SUN, *MON, *TUE, *WED, *THU, *FRI, *SAT Optional, Positional 1
PWRONTIME CL var for PWRONTIME (6) Character value Optional
PWROFFTIME CL var for PWROFFTIME (6) Character value Optional
DAYDESC CL var for DAYDESC (38) Character value Optional
MSGITV CL var for MSGITV (2 0) Decimal number Optional
Top

Day (DAY)

Specifies the day for which you are retrieving a power on/off schedule entry.

*TODAY
The current date's schedule entry is retrieved.
*SUN
The schedule entry for Sunday is retrieved.
*MON
The schedule entry for Monday is retrieved.
*TUE
The schedule entry for Tuesday is retrieved.
*WED
The schedule entry for Wednesday is retrieved.
*THU
The schedule entry for Thursday is retrieved.
*FRI
The schedule entry for Friday is retrieved.
*SAT
The schedule entry for Saturday is retrieved.
date
Specify the date for which a schedule entry is to be retrieved. The date must be specified in the same format as specified by your job attributes.
Top

CL var for PWRONTIME (6) (PWRONTIME)

Specifies the name of the CL variable that receives the power on time. The variable named has a minimum length of 6 characters. The special value *NONE or the time in the format hhmmss, where hh = hours,mm = minutes, and ss = seconds, is returned.

Top

CL var for PWROFFTIME (6) (PWROFFTIME)

Specifies the name of the CL variable that receives the power off time. The variable named has a minimum length of 6 characters. The special value *NONE or the time in the format hhmmss, where hh = hours,mm = minutes, and ss = seconds, is returned.

Top

CL var for DAYDESC (38) (DAYDESC)

Specifies the name of the CL variable that receives the day description value. The day description is an explanation of the power on/off schedule for that date. The variable named has a minimum length of 38 characters.

Top

CL var for MSGITV (2 0) (MSGITV)

Specifies the name of the CL variable that receives the message interval value. The message interval is the number of minutes before the scheduled power off that a message is sent to all work stations warning users of the power off. The variable named has a minimum length of 2 characters.

Top

Examples

Example 1: Retrieving Today's Schedule Entry

DCL   VAR(&ONTIME)  TYPE(*CHAR)  LEN(6)
DCL   VAR(&OFFTIME)  TYPE(*CHAR)  LEN(6)
RTVPWRSCDE   DAY(*TODAY)  PWRONTIME(&ONTIME) +
             PWROFFTIME(&OFFTIME)

This command retrieves the power on and off times for today.

Example 2: Retrieving Tuesday's Schedule Entry

DCL   VAR(&ONTIME)  TYPE(*CHAR)  LEN(6)
DCL   VAR(&OFFTIME)  TYPE(*CHAR)  LEN(6)
RTVPWRSCDE   DAY(*TUE)  PWRONTIME(&ONTIME)  PWROFFTIME(&OFFTIME)

This command retrieves the power on and power off times for Tuesday's.

Top

Error messages

*ESCAPE Messages

CPF1E2B
Power scheduler and cleanup options not found.
CPF1E23
Power schedule or cleanup options in use by another user.
CPF1E99
Unexpected error occurred.
CPF2105
Object &1 in &2 type *&3 not found.
CPF9808
Cannot allocate one or more libraries on library list.
Top