VALID_CALE

Script Function: Checks whether a date is included in the Calendar Event

Syntax

VALID_CALE ([Date Format:]Date, Calendar, Calendar Event)

Syntax

Description/Format

Date

Date in YYMMDD or YYYYMMDD format

Format: script literal or script variable

(Optional) You can specify a different date format: enter the desired date format, a separator (: or ;) and the date.

Calendar

Name of the Calendar object
Format: AE name, script literal or script variable

Calendar Event

Name of the Calendar Event
Format: AE name, script literal or script variable


Return codes

"Y" - The date is included in the Calendar Event
"N" - The date is not included in the Calendar Event

Optionally, you may specify a particular Date Format. The default Date Formats to be used are "YYMMDD" or "YYYYMMDD". A colon or semicolon may be used as a separator between Date Format and Date.

Examples

The example shown below checks if the current date is valid within the work schedule calendar. The return value of the function is stored in a script variable.

:SET &CURDATE# = SYS_DATE() 
:
SET &OPERATOR#=VALID_CALE(&CURDATE#,"READINESS","WORKDAY")

See also:

seealso

Script Date and Time Functions

Date, Time and Period Formats in Scripts

Calendars (CALE)