friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
14ed2849c6
ibm-information-center/dist/eclipse/plugins/i5OS.ic.cl_5.4.0.1/rtvpwrscde.htm

210 lines
7.4 KiB
HTML
Raw Blame History

<!doctype html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head><META http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Retrieve Power Schedule Entry (RTVPWRSCDE)</title>
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body bgcolor="white">
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<a name="RTVPWRSCDE.Top_Of_Page"></a>
<h2>Retrieve Power Schedule Entry (RTVPWRSCDE)</h2>
<table width="100%">
<tr>
<td valign="top" align="left"><b>Where allowed to run: </b>Compiled CL program or interpreted REXX (*BPGM *IPGM *BREXX *IREXX)<br>
<b>Threadsafe: </b>No
</td>
<td valign="top" align="right">
<a href="#RTVPWRSCDE.PARAMETERS.TABLE">Parameters</a><br>
<a href="#RTVPWRSCDE.COMMAND.EXAMPLES">Examples</a><br>
<a href="#RTVPWRSCDE.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="RTVPWRSCDE"></a>
<p>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.
</p>
<p><b>Restrictions:</b>
</p>
<ol>
<li>To use this command, you must have use (*USE) authority to the Display Power On/Off Schedule (DSPPWRSCD) command.
</li>
</ol>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVPWRSCDE.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="RTVPWRSCDE.PARAMETERS.TABLE">Parameters</a></h3>
<table border="1" cellpadding="4" cellspacing="0">
<!-- col1="10" col2="15" col3="30" col4="10" -->
<tr>
<th bgcolor="aqua" valign="bottom" align="left">Keyword</th>
<th bgcolor="aqua" valign="bottom" align="left">Description</th>
<th bgcolor="aqua" valign="bottom" align="left">Choices</th>
<th bgcolor="aqua" valign="bottom" align="left">Notes</th>
</tr>
<tr>
<td valign="top"><a href="#RTVPWRSCDE.DAY"><b>DAY</b></a></td>
<td valign="top">Day</td>
<td valign="top"><i>Date</i>, <b><u>*TODAY</u></b>, *SUN, *MON, *TUE, *WED, *THU, *FRI, *SAT</td>
<td valign="top">Optional, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#RTVPWRSCDE.PWRONTIME"><b>PWRONTIME</b></a></td>
<td valign="top">CL var for PWRONTIME (6)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVPWRSCDE.PWROFFTIME"><b>PWROFFTIME</b></a></td>
<td valign="top">CL var for PWROFFTIME (6)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVPWRSCDE.DAYDESC"><b>DAYDESC</b></a></td>
<td valign="top">CL var for DAYDESC (38)</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVPWRSCDE.MSGITV"><b>MSGITV</b></a></td>
<td valign="top">CL var for MSGITV (2 0)</td>
<td valign="top"><i>Decimal number</i></td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#RTVPWRSCDE.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="RTVPWRSCDE.DAY"></a>
<h3>Day (DAY)</h3>
<p>Specifies the day for which you are retrieving a power on/off schedule entry.
</p>
<dl>
<dt><b><u>*TODAY</u></b></dt>
<dd>The current date's schedule entry is retrieved.
</dd>
<dt><b>*SUN</b></dt>
<dd>The schedule entry for Sunday is retrieved.
</dd>
<dt><b>*MON</b></dt>
<dd>The schedule entry for Monday is retrieved.
</dd>
<dt><b>*TUE</b></dt>
<dd>The schedule entry for Tuesday is retrieved.
</dd>
<dt><b>*WED</b></dt>
<dd>The schedule entry for Wednesday is retrieved.
</dd>
<dt><b>*THU</b></dt>
<dd>The schedule entry for Thursday is retrieved.
</dd>
<dt><b>*FRI</b></dt>
<dd>The schedule entry for Friday is retrieved.
</dd>
<dt><b>*SAT</b></dt>
<dd>The schedule entry for Saturday is retrieved.
</dd>
<dt><b><i>date</i></b></dt>
<dd>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.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVPWRSCDE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVPWRSCDE.PWRONTIME"></a>
<h3>CL var for PWRONTIME (6) (PWRONTIME)</h3>
<p>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 <b>hhmmss</b>, where <b>hh = hours,</b><b>mm = minutes</b>, and <b>ss = seconds</b>, is returned.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVPWRSCDE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVPWRSCDE.PWROFFTIME"></a>
<h3>CL var for PWROFFTIME (6) (PWROFFTIME)</h3>
<p>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 <b>hhmmss</b>, where <b>hh = hours,</b><b>mm = minutes</b>, and <b>ss = seconds</b>, is returned.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVPWRSCDE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVPWRSCDE.DAYDESC"></a>
<h3>CL var for DAYDESC (38) (DAYDESC)</h3>
<p>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.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVPWRSCDE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVPWRSCDE.MSGITV"></a>
<h3>CL var for MSGITV (2 0) (MSGITV)</h3>
<p>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.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVPWRSCDE.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="RTVPWRSCDE.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Retrieving Today's Schedule Entry</b>
</p>
<p>
<pre>
DCL VAR(&amp;ONTIME) TYPE(*CHAR) LEN(6)
DCL VAR(&amp;OFFTIME) TYPE(*CHAR) LEN(6)
RTVPWRSCDE DAY(*TODAY) PWRONTIME(&amp;ONTIME) +
PWROFFTIME(&amp;OFFTIME)
</pre>
</p>
<p>This command retrieves the power on and off times for today.
</p>
<p><b>Example 2: Retrieving Tuesday's Schedule Entry</b>
</p>
<p>
<pre>
DCL VAR(&amp;ONTIME) TYPE(*CHAR) LEN(6)
DCL VAR(&amp;OFFTIME) TYPE(*CHAR) LEN(6)
RTVPWRSCDE DAY(*TUE) PWRONTIME(&amp;ONTIME) PWROFFTIME(&amp;OFFTIME)
</pre>
</p>
<p>This command retrieves the power on and power off times for Tuesday's.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVPWRSCDE.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="RTVPWRSCDE.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF1E2B</b></dt>
<dd>Power scheduler and cleanup options not found.
</dd>
<dt><b>CPF1E23</b></dt>
<dd>Power schedule or cleanup options in use by another user.
</dd>
<dt><b>CPF1E99</b></dt>
<dd>Unexpected error occurred.
</dd>
<dt><b>CPF2105</b></dt>
<dd>Object &amp;1 in &amp;2 type *&amp;3 not found.
</dd>
<dt><b>CPF9808</b></dt>
<dd>Cannot allocate one or more libraries on library list.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVPWRSCDE.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink