$darkmode
Libical API Documentation 4.0 STABLE VERSION Visit the v3.0 documentation
icalgauge.c File Reference

Routines implementing a filter for ical components. More...

Go to the source code of this file.

Functions

bool icalgauge_compare (icalgauge *gauge, icalcomponent *comp)
 
void icalgauge_dump (icalgauge *gauge)
 
void icalgauge_free (icalgauge *gauge)
 
int icalgauge_get_expand (const icalgauge *gauge)
 
icalgauge * icalgauge_new_from_sql (const char *sql, int expand)
 

Detailed Description

Routines implementing a filter for ical components.

Definition in file icalgauge.c.

Function Documentation

bool icalgauge_compare ( icalgauge *  g,
icalcomponent *  comp 
)

Returns true if comp matches the gauge.

Parameters
ga pointer to a valid icalgauge
compa pointer to a valid icalcomponent

The component comp must be in canonical form, i.e. a VCALENDAR with either a VEVENT, VTODO or VJOURNAL sub-component.

Returns
true if there's a match; false otherwise.

needs to use recurrence-id to do comparison

Definition at line 216 of file icalgauge.c.

void icalgauge_dump ( icalgauge *  gauge)

(Debug) Prints gauge information to STDOUT.

Parameters
gaugeis a pointer to a vaid icalgauge.

Definition at line 382 of file icalgauge.c.

void icalgauge_free ( icalgauge *  gauge)

Frees memory for the specified icalgauge.

Parameters
gaugea non-NULL pointer to valid icalgauge

Definition at line 72 of file icalgauge.c.

int icalgauge_get_expand ( const icalgauge *  gauge)

Returns the expand value for the specified icalgauge.

Parameters
gaugeis a pointer to a valid icalgauge.
Returns
the expanded gauge integer value. or -1 if gauge is NULL.

Definition at line 66 of file icalgauge.c.

icalgauge* icalgauge_new_from_sql ( const char *  sql,
int  expand 
)

Construct a new icalguage from SQL with a specified expand value.

Parameters
sqlis a pointer to a char string containing a valid SQL command
expandsome integer to associate with this icalgauge
Returns
a pointer to the newly construct icalgauge or NULL if the SQL parser failed.

Definition at line 38 of file icalgauge.c.