Main Page   Compound List   File List   Compound Members   File Members  

DT_EVENT Struct Reference

The DT_EVENT structure is used to schedule an event. More...

#include <date.h>

List of all members.

Public Attributes

DT_DATEstart_date
DT_DATEend_date
int interval_type
int interval_length
int event_length
int ordinal
int day
int adj_rel
int adj_sign
int adj_dow
char* pattern
void* data


Detailed Description

The DT_EVENT structure is used to schedule an event.

The event can be a one time event, or a recurring event. Recurring events can be set up to recur at regular intervals, or at certain times of the month, or even follow a predetermined pattern.

Do not access this structure directly. Instead, use the functions available in the date library.


Member Data Documentation

int DT_EVENT::adj_dow

Which day to adjust to.

int DT_EVENT::adj_rel

The number of days to add to the final date.

int DT_EVENT::adj_sign

Adjust forward or backward (or not at all) for adj_dow?

void * DT_EVENT::data

User supplied data for this event.

int DT_EVENT::day

For the specific day of month, or weekday.

DT_DATE * DT_EVENT::end_date

Point after which no more events will occur.

int DT_EVENT::event_length

How many days will this event last?

int DT_EVENT::interval_length

Time between events, either in days or months.

int DT_EVENT::interval_type

DT_INTERVAL_DAY, DT_INTERVAL_MONTH, DT_INTERVAL_MONTH_DOW.

int DT_EVENT::ordinal

DT_FIRST, etc, for weekdays.

char * DT_EVENT::pattern

Irregular event patterns.

DT_DATE * DT_EVENT::start_date

When the first event is.


The documentation for this struct was generated from the following file:
Generated at Fri May 12 15:50:03 2000 for Date Manipulation Library by doxygen 1.1.3 written by Dimitri van Heesch, © 1997-2000