Product Documentation

RTVSIMDATE (Retrieve SIMDATE Information) Command

>>--RTVSIMDATE----- --------------------------------- -------------------------------------->
                   |--STATUS(--&CL-variable-name--)--|

>---- ------------------------------------------------------------------ ------------------->
     |--USEDATE(--&CL-variable-name--)----------------------------------|

>---- ------------------------------------------------------------------ ------------------->
     |--CHGJOB(--&CL-variable-name--)-----------------------------------|

>---- ------------------------------------------------------------------ ------------------->
     |--ORIGJOB(--&CL-variable-name--)----------------------------------|

>---- ------------------------------------------------------------------ ------------------->
     |--PROPAGATE(--&CL-variable-name--)--------------------------------|

>---- ------------------------------------------------------------------ -------------------><
     |--RELATIVE(--&CL-variable-name--)---------------------------------|

Notes:

All parameters can be specified in positional form.

The Retrieve SIMDATE Information (RTVSIMDATE) command is used in a CL program or REXX procedure to retrieve the current status of parameters maintained internally by the SIMDATE Date Intercept Facility. For additional information on the SIMDATE Date Intercept Facility, please see the help for the SIMDATE command.

The values are returned (copied) to the specified CL variables.

Restriction: The attributes of the SIMDATE parameter and the receiving CL variable must be compatible.

Parameters

STATUS
Specifies the name of the CL variable that receives the current status of the SIMDATE Date Intercept Facility. Specify the name of a character variable with a minimum length of 4 characters. Possible values are:

• *ON: The SIMDATE Date Intercept Facility is enabled. Additional information is shown in subsequent parameters. Future requests for the current date will return the specified date in place of the current system date.

• *OFF: The SIMDATE Date Intercept Facility is not enabled. The system behaves as though the SIMDATE product was not installed.

USEDATE
Specifies the name of the CL variable that receives the date that SIMDATE will return for this job in place of the current date. The date is specified based on the current job date format. If RELATIVE(*YES) is specified, this date will be adjusted if this job runs past midnight. Specify the name of a character variable with a minimum length of 8 characters.

CHGJOB
Specifies the name of the CL variable that receives an indication as to whether or not the job date was changed (in addition to the current date) for this job. Specify the name of a character variable with a minimum length of 4 characters. Possible values are:

• *YES: The job date for this job was changed (in addition to the system date). The original job date (shown in the next parameter) will be restored when SIMDATE SET(*OFF) is executed.

• *NO: The job date for this job was not changed.

ORIGJOB
Specifies the name of the CL variable that receives the job date for this job before the SIMDATE command was executed. The date is specified based on the current job date format. Specify the name of a character variable with a minimum length of 8 characters.

PROPAGATE
Specifies the name of the CL variable that receives an indication as to whether or not jobs submitted from this job will inherit the SIMDATE settings from this job. Specify the name of a character variable with a minimum length of 4 characters. Possible values are:

• *YES: Any job submitted from this job by the SBMJOB command will inherit the SIMDATE settings from this job as if those settings were specified at the beginning of the submitted job. If the RTGDTA parameter is used on the SBMJOB command, it must specify a program which will properly interpret a CALL command placed as the last entry in the submitted job's message queue.

• *NO: Any job submitted from this job by the SBMJOB command will behave as if SIMDATE was not in effect for the submitting job.

RELATIVE
Specifies the name of the CL variable that receives an indication as to whether or not the SIMDATE date will change if the system date changes while this job is under SIMDATE control. Specify the name of a character variable with a minimum length of 4 characters. Possible values are:

• *YES: The SIMDATE date will change if the system date changes while this job is under SIMDATE control. In other words, if this job runs past midnight, the SIMDATE will also change.

• *NO: The SIMDATE date will not change if the system date changes while this job is under SIMDATE control. The date computed now will be used for this job even if this job runs past midnight.

Example 1:

     DCL  VAR(&STATUS)  TYPE(*CHAR)  LEN(4)
     RTVSIMDATE STATUS(&STATUS)

For more information, please see our fact sheet and our list of benefits.  If these don't answer your questions, check out our FAQ or  email  us.  Of course, you can always call us at 1-323-658-1146. 
 
 

Copyright © 1997, 1998 by The Firstech Corporation.