cal_weekday() — Apollo

CAL_$WEEKDAY                      Domain/OS                       CAL_$WEEKDAY


NAME
     cal_$weekday - return the weekday for a date

SYNOPSIS (C)
     #include <apollo/base.h>
     #include <apollo/cal.h>

     cal_$weekday_t cal_$weekday(
          short &year,
          short &month,
          short &day)

SYNOPSIS (Pascal)
     %include '/sys/ins/base.ins.pas';
     %include '/sys/ins/cal.ins.pas';

     function cal_$weekday(
          in year: integer;
          in month: integer;
          in day: integer): cal_$weekday_t;

SYNOPSIS (FORTRAN)
     %include '/sys/ins/base.ins.ftn'
     %include '/sys/ins/cal.ins.ftn'

           integer*2 weekday, year, month, day

           weekday = cal_$weekday(year, month, day)

DESCRIPTION
     Cal_$weekday returns the day of the week for the Gregorian date specified
     by year, month, and day.  The value returned has the enumerated type
     cal_$weekday_t, and can be one of the following predefined values:
                               cal_$sun   Sunday
                               cal_$mon   Monday
                               cal_$tue   Tuesday
                               cal_$wed   Wednesday
                               cal_$thu   Thursday
                               cal_$fri   Friday
                               cal_$sat   Saturday

     year The year for which the weekday is desired.

     month
          The month for which the weekday is desired.

     day  The day of the month for which the weekday is desired.
Museum
