Baillehache Pascal's personal website

LibCapy - date

Date class.

Macros:

#define CAPY_DATE_H

Enumerations:

typedef enum CapyDateUnit {
  capyDateUnit_year,
  capyDateUnit_month,
  capyDateUnit_day,
  capyDateUnit_hour,
  capyDateUnit_minute,
  capyDateUnit_second,
  capyDateUnit_nb,
} CapyDateUnit;

Date units

typedef enum CapyWeekDay {
  capyWeekDay_sunday,
  capyWeekDay_monday,
  capyWeekDay_tuesday,
  capyWeekDay_wednesday,
  capyWeekDay_thursday,
  capyWeekDay_friday,
  capyWeekDay_saturday,
  capyWeekDay_nb,
} CapyWeekDay;

Day of week

Typedefs:

typedef int16_t CapyDate_t;

Type for the values of a CapyDate

typedef struct CapyDate CapyDate;

Date object

Functions:

CapyDate CapyDateCreate(void);

Create a CapyDate

Output and side effect(s):

Return a CapyDate

CapyDate* CapyDateAlloc(void);

Allocate memory for a new CapyDate and create it

Output and side effect(s):

Return a CapyDate

Exception(s):

May raise CapyExc_MallocFailed.

void CapyDateFree(CapyDate** const that);

Free the memory used by a CapyDate* and reset '*that' to NULL

Input argument(s):

that: a pointer to the CapyDate to free

2024-03-20
in LibCapy,
1 views