Functions#
- get_unknown_token_handling_setting() _unknown_token_handling #
- icalarray_free(array: array) None #
par
Usage// create new array icalarray *array = icalarray_new(sizeof(int), 1); // use array int a = 4; icalarray_append(array, &a); assert(*icalarray_element_at(array, 0) == a); // release memory icalarray_free(array);
- Parameters:
array
- icalcomponent_add_property(component: component, property: property) None #
- Parameters:
component
property
- icalcomponent_count_components(component: component, kind: component_kind) int #
- Parameters:
component
kind
- icalcomponent_count_properties(component: component, kind: property_kind) int #
- Parameters:
component
kind
- icalcomponent_foreach_recurrence(comp: component, start: Any = None, end: Any = None, callback: Any = None, callback_data: Any = None) None #
- Parameters:
comp
start
end
callback
callback_data
- icalcomponent_foreach_tzid(comp: component, callback: Any = None, callback_data: Any = None) None #
- Parameters:
comp
callback
callback_data
- icalcomponent_get_method(comp: component) property_method #
- Parameters:
comp
- icalcomponent_isa(component: component) component_kind #
- Parameters:
component
- icalcomponent_kind_is_valid(kind: component_kind) int #
- Parameters:
kind
- icalcomponent_kind_to_string(kind: component_kind) str #
- Parameters:
kind
- icalcomponent_merge_component(comp: component, comp_to_merge: component) None #
- Parameters:
comp
comp_to_merge
- icalcomponent_remove_property(component: component, property: property) None #
- Parameters:
component
property
- icalcomponent_set_method(comp: component, method: property_method) None #
- Parameters:
comp
method
- icalcomponent_set_parent(component: component, parent: component) None #
- Parameters:
component
parent
- icalcomponent_string_to_kind(string: str) component_kind #
- Parameters:
string
- icalenum_num_to_reqstat(major: int, minor: int) requeststatus #
- Parameters:
major
minor
- icalenum_reqstat_code(stat: requeststatus) str #
- Parameters:
stat
- icalenum_reqstat_code_r(stat: requeststatus) str #
- Parameters:
stat
- icalenum_reqstat_desc(stat: requeststatus) str #
- Parameters:
stat
- icalenum_reqstat_major(stat: requeststatus) int #
- Parameters:
stat
- icalenum_reqstat_minor(stat: requeststatus) int #
- Parameters:
stat
- icalerror_get_error_state(error: errorenum) errorstate #
- Parameters:
error
- icalerror_restore(error: str, es: errorstate) None #
- Parameters:
error
es
- icalerror_set_error_state(error: errorenum, state: errorstate) None #
- Parameters:
error
state
- icalerror_supress(error: str) errorstate #
- Parameters:
error
- icalmemory_append_char(buf: str, pos: str, buf_size: int, ch: int) None #
- Parameters:
buf
pos
buf_size
ch
- icalmemory_append_string(buf: str, pos: str, buf_size: int, string: str) None #
- Parameters:
buf
pos
buf_size
string
- icalparameter_as_ical_string(parameter: parameter) str #
par
Usageicalparameter *param = icalparameter_new_from_string("ROLE=CHAIR"); if(param) { char *str = icalparameter_as_ical_string(param); printf("%s\n", str); free(str); } icalparameter_free(param);
- Parameters:
parameter
- icalparameter_get_actionparam(value: parameter) parameter_action #
- Parameters:
value
- icalparameter_get_cutype(value: parameter) parameter_cutype #
- Parameters:
value
- icalparameter_get_display(value: parameter) parameter_display #
- Parameters:
value
- icalparameter_get_enable(value: parameter) parameter_enable #
- Parameters:
value
- icalparameter_get_encoding(value: parameter) parameter_encoding #
- Parameters:
value
- icalparameter_get_fbtype(value: parameter) parameter_fbtype #
- Parameters:
value
- icalparameter_get_feature(value: parameter) parameter_feature #
- Parameters:
value
- icalparameter_get_local(value: parameter) parameter_local #
- Parameters:
value
- icalparameter_get_partstat(value: parameter) parameter_partstat #
- Parameters:
value
- icalparameter_get_patchaction(value: parameter) parameter_patchaction #
- Parameters:
value
- icalparameter_get_range(value: parameter) parameter_range #
- Parameters:
value
- Parameters:
value
- icalparameter_get_reltype(value: parameter) parameter_reltype #
- Parameters:
value
- icalparameter_get_required(value: parameter) parameter_required #
- Parameters:
value
- icalparameter_get_role(value: parameter) parameter_role #
- Parameters:
value
- icalparameter_get_rsvp(value: parameter) parameter_rsvp #
- Parameters:
value
- icalparameter_get_scheduleagent(value: parameter) parameter_scheduleagent #
- Parameters:
value
- icalparameter_get_scheduleforcesend(value: parameter) parameter_scheduleforcesend #
- Parameters:
value
- icalparameter_get_stayinformed(value: parameter) parameter_stayinformed #
- Parameters:
value
- icalparameter_get_substate(value: parameter) parameter_substate #
- Parameters:
value
- icalparameter_get_value(value: parameter) parameter_value #
- Parameters:
value
- icalparameter_get_xliccomparetype(value: parameter) parameter_xliccomparetype #
- Parameters:
value
- icalparameter_get_xlicerrortype(value: parameter) parameter_xlicerrortype #
- Parameters:
value
- icalparameter_isa(parameter: parameter) parameter_kind #
- Parameters:
parameter
- icalparameter_kind_is_valid(kind: parameter_kind) int #
- Parameters:
kind
- icalparameter_kind_to_string(kind: parameter_kind) str #
- Parameters:
kind
- icalparameter_set_actionparam(value: parameter, v: parameter_action) None #
- Parameters:
value
v
- icalparameter_set_cutype(value: parameter, v: parameter_cutype) None #
- Parameters:
value
v
- icalparameter_set_display(value: parameter, v: parameter_display) None #
- Parameters:
value
v
- icalparameter_set_enable(value: parameter, v: parameter_enable) None #
- Parameters:
value
v
- icalparameter_set_encoding(value: parameter, v: parameter_encoding) None #
- Parameters:
value
v
- icalparameter_set_fbtype(value: parameter, v: parameter_fbtype) None #
- Parameters:
value
v
- icalparameter_set_feature(value: parameter, v: parameter_feature) None #
- Parameters:
value
v
- icalparameter_set_local(value: parameter, v: parameter_local) None #
- Parameters:
value
v
- icalparameter_set_partstat(value: parameter, v: parameter_partstat) None #
- Parameters:
value
v
- icalparameter_set_patchaction(value: parameter, v: parameter_patchaction) None #
- Parameters:
value
v
- icalparameter_set_range(value: parameter, v: parameter_range) None #
- Parameters:
value
v
- Parameters:
value
v
- icalparameter_set_reltype(value: parameter, v: parameter_reltype) None #
- Parameters:
value
v
- icalparameter_set_required(value: parameter, v: parameter_required) None #
- Parameters:
value
v
- icalparameter_set_role(value: parameter, v: parameter_role) None #
- Parameters:
value
v
- icalparameter_set_rsvp(value: parameter, v: parameter_rsvp) None #
- Parameters:
value
v
- icalparameter_set_scheduleagent(value: parameter, v: parameter_scheduleagent) None #
- Parameters:
value
v
- icalparameter_set_scheduleforcesend(value: parameter, v: parameter_scheduleforcesend) None #
- Parameters:
value
v
- icalparameter_set_stayinformed(value: parameter, v: parameter_stayinformed) None #
- Parameters:
value
v
- icalparameter_set_substate(value: parameter, v: parameter_substate) None #
- Parameters:
value
v
- icalparameter_set_value(value: parameter, v: parameter_value) None #
- Parameters:
value
v
- icalparameter_set_xliccomparetype(value: parameter, v: parameter_xliccomparetype) None #
- Parameters:
value
v
- icalparameter_set_xlicerrortype(value: parameter, v: parameter_xlicerrortype) None #
- Parameters:
value
v
- icalparameter_string_to_kind(string: str) parameter_kind #
- Parameters:
string
- icalparameter_value_to_value_kind(value: parameter_value) value_kind #
- Parameters:
value
- icalparser_get_state(parser: parser) parser_state #
- Parameters:
parser
- icalparser_string_line_generator(out: str, buf_size: int, d: Any = None) str #
- Parameters:
out
buf_size
d
- icalproperty_enum_belongs_to_property(kind: property_kind, e: int) int #
- Parameters:
kind
e
- icalproperty_get_datetime_with_component(prop: property, comp: component) Any | None #
- Parameters:
prop
comp
- Parameters:
prop
- icalproperty_isa(property: property) property_kind #
- Parameters:
property
- icalproperty_kind_is_valid(kind: property_kind) int #
- Parameters:
kind
- icalproperty_kind_to_string(kind: property_kind) str #
- Parameters:
kind
- icalproperty_kind_to_value_kind(kind: property_kind) value_kind #
- Parameters:
kind
- icalproperty_method_to_string(method: property_method) str #
- Parameters:
method
- icalproperty_recurrence_is_excluded(comp: component, dtstart: Any = None, recurtime: Any = None) int #
- Parameters:
comp
dtstart
recurtime
- icalproperty_remove_parameter_by_kind(prop: property, kind: parameter_kind) None #
- Parameters:
prop
kind
- icalproperty_set_parameter_from_string(prop: property, name: str, value: str) None #
- Parameters:
prop
name
value
- icalproperty_set_parent(property: property, component: component) None #
- Parameters:
property
component
- Parameters:
prop
v
- icalproperty_set_value_from_string(prop: property, value: str, kind: str) None #
- Parameters:
prop
value
kind
- icalproperty_status_to_string(arg0: property_status) str #
- Parameters:
arg0
- icalproperty_string_to_kind(string: str) property_kind #
- Parameters:
string
- icalproperty_string_to_method(str: str) property_method #
- Parameters:
str
- icalproperty_string_to_status(string: str) property_status #
- Parameters:
string
- icalproperty_value_kind_to_kind(kind: value_kind) property_kind #
- Parameters:
kind
- icalrecur_expand_recurrence(rule: str, start: int, count: int, array: int) int #
- Parameters:
rule
start
count
array
- icalrecur_freq_to_string(kind: recurrencetype_frequency) str #
- Parameters:
kind
- icalrecur_iterator_free(arg0: recur_iterator) None #
- Parameters:
arg0
- icalrecur_iterator_next(arg0: recur_iterator) Any | None #
- Parameters:
arg0
- icalrecur_iterator_set_start(impl: recur_iterator, start: Any = None) int #
- Parameters:
impl
start
- icalrecur_skip_to_string(kind: recurrencetype_skip) str #
- Parameters:
kind
- icalrecur_string_to_freq(str: str) recurrencetype_frequency #
- Parameters:
str
- icalrecur_string_to_skip(str: str) recurrencetype_skip #
- Parameters:
str
- icalrecur_string_to_weekday(str: str) recurrencetype_weekday #
- Parameters:
str
- icalrecur_weekday_to_string(kind: recurrencetype_weekday) str #
- Parameters:
kind
- icalrestriction_compare(restr: restriction_kind, count: int) int #
- Parameters:
restr
count
- icaltime_adjust(tt: Any, days: int, hours: int, minutes: int, seconds: int) None #
- Parameters:
tt
days
hours
minutes
seconds
- icaltime_convert_to_zone(tt: Any, zone: timezone) Any | None #
There are several ways to create a new icaltimetype:
icaltime_null_time()
- icaltime_from_timet_with_zone(time_t tm, int is_date,
icaltimezone *zone)
icaltime_from_day_of_year(int doy, int year)
italtimetype objects can be converted to different formats:
- icaltime_as_timet(struct icaltimetype tt)
- icaltime_as_timet_with_zone(struct icaltimetype tt,
icaltimezone *zone)
icaltime_as_ical_string(struct icaltimetype tt)
Accessor methods include:
- icaltime_get_timezone(struct icaltimetype t)
icaltime_get_tzid(struct icaltimetype t)
icaltime_set_timezone(struct icaltimetype t, const icaltimezone *zone)
icaltime_day_of_year(struct icaltimetype t)
icaltime_day_of_week(struct icaltimetype t)
icaltime_start_doy_week(struct icaltimetype t, int fdow)
icaltime_week_number(struct icaltimetype t)
Query methods include:
- icaltime_is_null_time(struct icaltimetype t)
icaltime_is_valid_time(struct icaltimetype t)
icaltime_is_date(struct icaltimetype t)
icaltime_is_utc(struct icaltimetype t)
Modify, compare and utility methods include:
- icaltime_compare(struct icaltimetype a,struct icaltimetype b)
- Parameters:
tt
zone
- icaltime_from_string(str: str) Any | None #
is the same as that used by
icaldurationtype_from_string()
.par
Usage// create icalperiodtype const char *period_string = "20170606T090000/20170607T090000"; struct icalperiodtype period = icalperiodtype_from_string(period_string); // print period in iCal format printf("%s\n", icalperiodtype_as_ical_string(period));
- Parameters:
str
- icaltime_from_timet_with_zone(tm: int, is_date: int, zone: timezone) Any | None #
- Parameters:
tm
is_date
zone
- icaltime_span_new(dtstart: Any, dtend: Any, is_busy: int) Any | None #
- Parameters:
dtstart
dtend
is_busy
- icaltimezone_array_append_from_vtimezone(timezones: array, child: component) None #
- Parameters:
timezones
child
- icaltimezone_convert_time(tt: Any, from_zone: timezone, to_zone: timezone) None #
- Parameters:
tt
from_zone
to_zone
- icaltimezone_dump_changes(zone: timezone, max_year: int, fp: Any = None) int #
- Parameters:
zone
max_year
fp
- icaltimezone_expand_vtimezone(comp: component, end_year: int, changes: array) None #
- Parameters:
comp
end_year
changes
- icaltimezone_get_utc_offset(zone: timezone, tt: Any, is_daylight: int) int #
- Parameters:
zone
tt
is_daylight
- icaltimezone_get_utc_offset_of_utc_time(zone: timezone, tt: Any, is_daylight: int) int #
- Parameters:
zone
tt
is_daylight
- icaltimezone_truncate_vtimezone(vtz: component, start: timetype, end: timetype, ms_compatible: int) None #
- Parameters:
vtz
start
end
ms_compatible
- icalvalue_compare(a: value, b: value) parameter_xliccomparetype #
- Parameters:
a
b
- icalvalue_decode_ical_string(szText: str, szDecText: str, nMaxBufferLen: int) int #
- Parameters:
szText
szDecText
nMaxBufferLen
- icalvalue_encode_ical_string(szText: str, szEncText: str, MaxBufferLen: int) int #
- Parameters:
szText
szEncText
MaxBufferLen
- icalvalue_isa(value: value) value_kind #
- Parameters:
value
- icalvalue_kind_is_valid(kind: value_kind) int #
- Parameters:
kind
- icalvalue_kind_to_string(kind: value_kind) str #
- Parameters:
kind
- icalvalue_string_to_kind(str: str) value_kind #
- Parameters:
str
- set_unknown_token_handling_setting(newSetting: _unknown_token_handling) None #
- Parameters:
newSetting