ICalGLib – 4.0
Description: Reference for ICalGLib-4.0

### Namespace

# ICalGLib – 4.0

iCalendar protocols and protocol data units implementation

Version | 4
Authors | libical Development Team
License | LGPL-2.1-only OR MPL-2.0
Website | https://libical.github.io/libical/
Source | https://github.com/libical/libical

#### Build

C headers | `libical-glib/libical-glib.h`
pkg-config files | `libical-glib`

#### Dependencies

GObject—2.0 | The base type system library
| Browse documentation

#### Additional documentation

- Classes Hierarchy

#### Classes

Array | This is the ICalArray instance.
Attach | This is the ICalAttach instance.
CompIter | This is the ICalCompIter instance.
Component | This is the ICalComponent instance.
Datetimeperiod | This is the ICalDatetimeperiod instance.
Duration | This is the ICalDuration instance.
EnumArray | This is the ICalEnumArray instance.
Geo | This is the ICalGeo instance.
Object | This is an ICalObject instance struct.
Parameter | This is the ICalParameter instance.
ParamIter | This is the ICalParamIter instance.
Parser | This is the ICalParser instance.
Period | This is the ICalPeriod instance.
Property | This is the ICalProperty instance.
PropIter | This is the ICalPropIter instance.
RecurIterator | This is the ICalRecurIterator instance.
Recurrence | This is the ICalRecurrence instance.
Reqstat | This is the ICalReqstat instance.
StrArray | This is the ICalStrArray instance.
Time | This is the ICalTime instance.
TimeSpan | This is the ICalTimeSpan instance.
Timezone | This is the ICalTimezone instance.
Trigger | This is the ICalTrigger instance.
Value | This is the ICalValue instance.
VcardComponent | This is the ICalVcardComponent instance.
VcardEnumArray | This is the ICalVcardEnumArray instance.
VcardGeo | This is the ICalVcardGeo instance.
VcardParameter | This is the ICalVcardParameter instance.
VcardProperty | This is the ICalVcardProperty instance.
VcardStrArray | This is the ICalVcardStrArray instance.
VcardStructured | This is the ICalVcardStructured instance.
VcardTime | This is the ICalVcardTime instance.
VcardTz | This is the ICalVcardTz instance.
VcardValue | This is the ICalVcardValue instance.

#### Structs

_Array |
_Attach |
_CompIter |
_Component |
_Datetimeperiod |
_Duration |
_EnumArray |
_Geo |
_Parameter |
_ParamIter |
_Parser |
_Period |
_Property |
_PropIter |
_RecurIterator |
_Recurrence |
_Reqstat |
_StrArray |
_Time |
_TimeSpan |
_Timezone |
_Trigger |
_Value |
_VcardComponent |
_VcardEnumArray |
_VcardGeo |
_VcardParameter |
_VcardProperty |
_VcardStrArray |
_VcardStructured |
_VcardTime |
_VcardTz |
_VcardValue |

#### Enumerations

ComponentKind |
ErrorEnum |
ErrorState |
InvalidRruleHandling |
LimitsKind | The types of limits.
ParameterAction |
ParameterCutype |
ParameterDerived |
ParameterDisplay |
ParameterEnable |
ParameterEncoding |
ParameterFbtype |
ParameterFeature |
ParameterKind |
ParameterLocal |
ParameterPartstat |
ParameterPatchaction |
ParameterRange |
ParameterRelated |
ParameterReltype |
ParameterRequired |
ParameterRole |
ParameterRsvp |
ParameterScheduleagent |
ParameterScheduleforcesend |
ParameterStayinformed |
ParameterSubstate |
ParameterValue |
ParameterXliccomparetype |
ParameterXlicerrortype |
ParserCtrl |
ParserState |
PropertyAction |
PropertyBusytype |
PropertyCarlevel |
PropertyClassenum |
PropertyCmd |
PropertyKind |
PropertyMethod |
PropertyParticipanttype |
PropertyPollcompletion |
PropertyPollmode |
PropertyProximity |
PropertyQuerylevel |
PropertyResourcetype |
PropertyStatus |
PropertyTaskmode |
PropertyTransp |
PropertyXlicclass |
RecurrenceArraySizes |
RecurrenceByRule |
RecurrenceFrequency |
RecurrenceSkip |
RecurrenceWeekday |
RequestStatus |
RestrictionKind |
Unknowntokenhandling |
ValueKind |
VcardAdrField |
VcardClientpidmapField |
VcardComponentKind |
VcardGenderField |
VcardNField |
VcardParameterCalscale |
VcardParameterDerived |
VcardParameterEncoding |
VcardParameterKind |
VcardParameterLevel |
VcardParameterPhonetic |
VcardParameterType |
VcardParameterValue |
VcardParameterXliccomparetype |
VcardParameterXlicerrortype |
VcardPropertyGramgender |
VcardPropertyKind |
VcardPropertyKindenum |
VcardPropertyVersion |
VcardRestrictionKind |
VcardTimeConvertFlags |
VcardValueKind |

#### Callbacks

ComponentForeachRecurrenceFunc |
ComponentForeachTZIDFunc |
ParserLineGenFunc |
VcardXpropValueKindFunc |

#### Functions

enumarray_clone | Creates a deep copy of `ICalEnumArray` with the same properties as the `array`. since: 4.0
enumarray_free | Frees the `ICalEnumArray`. since: 4.0
enumarray_remove_element_at | Removes the element at the `position` from the array. since: 4.0
error_clear_errno | since: 1.0
error_error_from_string | Reads an error from a string. since: 4.0
error_get_error_state | Gets the state of an error. since: 1.0
error_get_errors_are_fatal | Determine whether errors are fatal. since: 4.0
error_icalerrno | Returns the error stored in the library. If no error, return I_CAL_NO_ERROR. since: 1.0
error_perror | Gets the `ICalErrorEnum` in the string representation. This method called the icalerrorno_return to get the current error. since: 1.0
error_restore | Restores the error to specified state. since: 1.0
error_set_errno | Sets the errno. since: 1.0
error_set_error_state | Sets the state to the corresponding error in the library. since: 1.0
error_set_errors_are_fatal | Sets whether errors are fatal, that is, whether libical aborts after any processing reports an error. since: 4.0
error_strerror | Translates the `ICalErrorEnum` to the string representation. since: 1.0
error_supress | Suppresses the error. since: 1.0
get_unknown_token_handling_setting | Gets the setting of `ICalUnknowntokenhandling`. since: 1.0
i_calerror_backtrace | since: 1.0
limit_get | Gets the value for the corresponding internal library limit. since: 4.0
limit_set | Sets the value for the corresponding internal library limit. since: 4.0
memory_add_tmp_buffer | Adds an existing buffer to the buffer ring. since: 1.0
memory_append_char | Append the character to the buffer. Only use them on normally allocated memory, or on buffers created from icalmemory_new_buffer, never with buffers created by icalmemory_tmp_buffer. If icalmemory_append_string has to resize a buffer on the ring, the ring will loose track of it and you will have memory problems. since: 1.0
memory_append_decoded_string | Decodes the string as TEXT value and then appends it to the buffer. Only use them on normally allocated memory, or on buffers created from icalmemory_new_buffer, never with buffers created by icalmemory_tmp_buffer. If icalmemory_append_decoded_string has to resize a buffer on the ring, the ring will loose track of it and you will have memory problems. since: 4.0
memory_append_encoded_string | Encodes the string as TEXT value and then appends it to the buffer. Only use them on normally allocated memory, or on buffers created from icalmemory_new_buffer, never with buffers created by icalmemory_tmp_buffer. If icalmemory_append_encoded_string has to resize a buffer on the ring, the ring will loose track of it and you will have memory problems. since: 4.0
memory_append_string | Appends the string to the buffer. Only use them on normally allocated memory, or on buffers created from icalmemory_new_buffer, never with buffers created by icalmemory_tmp_buffer. If icalmemory_append_string has to resize a buffer on the ring, the ring will loose track of it and you will have memory problems. since: 1.0
memory_free_buffer | Frees the buffer. since: 1.0
memory_free_ring | Frees all the memory used in the ring. since: 1.0
memory_new_buffer | Creates a new buffer with target size. The caller should deallocate it when necessary. since: 1.0
memory_resize_buffer | Resizes the buffer to the target size. since: 1.0
memory_str_to_glib | Transform a string allocated with icalmemory into one that can be freed with g_free. since: 1.0
memory_strdup | A wrapper around strdup. Partly to trap calls to strdup, partly because in -ansi, gcc on Red Hat claims that strdup is undeclared. since: 1.0
memory_tmp_buffer | Creates a buffer with target size. since: 1.0
memory_tmp_copy | Like strdup, but the buffer is on the ring. since: 1.0
priv_i_cal_vcard_null_geo | Returns null/empty vcardgeotype structure. since: 1.0
priv_i_cal_vcard_null_tz | Returns null/empty vcardtztype structure. since: 1.0
recur_expand_recurrence | Fills an array with the ‘count’ number of occurrences generated by the rrule. Note that the times are returned in UTC, but the times are calculated in local time. YOu will have to convert the results back into local time before using them. since: 1.0
recur_get_invalid_rrule_handling_setting | Returns the current behaviour what to do when an RRULE is invalid. since: 4.0
recur_set_invalid_rrule_handling_setting | Sets what to do when an invalid RRULE is recognized. since: 4.0
request_status_code | Returns the code for a request status. since: 1.0
request_status_desc | Returns the descriptive text for a request status. since: 1.0
request_status_from_num | Returns a request status for major/minor status numbers. since: 1.0
request_status_major | Returns the major number for a request status. since: 1.0
request_status_minor | Returns the minor number for a request status. since: 1.0
restriction_check | Checks whether the `ICalComponent` is valid. since: 1.0
restriction_compare | Compares the kind of restriction and the count to determine whether it is valid. since: 1.0
set_unknown_token_handling_setting | Sets `ICalUnknowntokenhandling`. since: 1.0
vcard_parser_errstr | Converts an error code into its text representation. since: 4.0
vcard_parser_parse_string | Parses the vCard string `str` and returns an `ICalVcardComponent`, or `NULL` when the parse failed. since: 4.0
vcard_parser_set_xprop_value_kind | Registers a parser callback to override the default value type of an x-property. since: 4.0
vcard_restriction_check | Checks whether the `comp` is valid. since: 1.0
vcard_restriction_compare | Checks if the given `count` is in accordance with the given restriction, `restr`. since: 1.0

#### Function Macros

GLIB_DECLARE_DERIVABLE_TYPE |