Libical API Documentation
3.0
|
Go to the source code of this file.
Functions | |
char * | icalparameter_as_ical_string (icalparameter *parameter) |
Converts icalparameter into a string representation. More... | |
char * | icalparameter_as_ical_string_r (icalparameter *parameter) |
Converts icalparameter into an string representation according to RFC5445/RFC6868. More... | |
void | icalparameter_free (icalparameter *parameter) |
Frees an icalparameter object. More... | |
const char * | icalparameter_get_iana_name (icalparameter *param) |
Returns the IANA name of param. More... | |
const char * | icalparameter_get_iana_value (icalparameter *param) |
Returns the IANA value of param. More... | |
const char * | icalparameter_get_xname (icalparameter *param) |
Returns the X-name of param. More... | |
const char * | icalparameter_get_xvalue (icalparameter *param) |
Returns the X-value of param. More... | |
int | icalparameter_has_same_name (icalparameter *param1, icalparameter *param2) |
Determines if two parameters have the same name. More... | |
icalparameter_kind | icalparameter_isa (icalparameter *parameter) |
int | icalparameter_isa_parameter (void *param) |
int | icalparameter_kind_is_valid (const icalparameter_kind kind) |
Checks the validity of a icalparameter_kind. More... | |
const char * | icalparameter_kind_to_string (icalparameter_kind kind) |
Returns a string representing the given icalparameter_kind. More... | |
icalparameter * | icalparameter_new (icalparameter_kind kind) |
Creates new icalparameter object. More... | |
icalparameter * | icalparameter_new_clone (icalparameter *p) |
Creates new icalparameter as a clone of the given one. More... | |
icalparameter * | icalparameter_new_from_string (const char *value) |
Creates new icalparameter object from string. More... | |
icalparameter * | icalparameter_new_from_value_string (icalparameter_kind kind, const char *value) |
Creates new icalparameter of a given kind with a given value. More... | |
void | icalparameter_set_iana_name (icalparameter *param, const char *v) |
Sets the IANA name of param to v. More... | |
void | icalparameter_set_iana_value (icalparameter *param, const char *v) |
Sets the IANA value of param to v. More... | |
void | icalparameter_set_xname (icalparameter *param, const char *v) |
Sets the X-name of param to v. More... | |
void | icalparameter_set_xvalue (icalparameter *param, const char *v) |
Sets the X-value of param to v. More... | |
icalparameter_kind | icalparameter_string_to_kind (const char *string) |
Returns the icalparameter_kind for a given string. More... | |
Functions to work with ical parameter objects, which represent parameters to property objects.
char* icalparameter_as_ical_string | ( | icalparameter * | parameter | ) |
Converts icalparameter into a string representation.
parameter | The icalparameter to convert |
NULL
. Furthermore, if parameter is NULL
, it also sets icalerrno to ICAL_BADARG_ERROR. If it doesn't recognize the kind of the parameter, it sets icalerrno it ICAL_BADARG_ERROR. If the parameter is otherwise malformed, it sets icalerrno to ICAL_MALFORMEDDATA_ERROR.```c icalparameter *param = icalparameter_new_from_string("ROLE=CHAIR");
if(param) { printf("%s\n", icalparameter_as_ical_string(param)); }
icalparameter_free(param);
char* icalparameter_as_ical_string_r | ( | icalparameter * | parameter | ) |
Converts icalparameter into an string representation according to RFC5445/RFC6868.
parameter | The icalparameter to convert |
NULL
. Furthermore, if parameter is NULL
, it also sets icalerrno to ICAL_BADARG_ERROR. If it doesn't recognize the kind of the parameter, it sets icalerrno to ICAL_BADARG_ERROR. If the parameter is otherwise malformed, it sets icalerrno to ICAL_MALFORMEDDATA_ERROR.free()
d after use. A version of this function which returns strings that do not need to be freed manually is icalparameter_as_ical_string().```c icalparameter *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);
void icalparameter_free | ( | icalparameter * | parameter | ) |
Frees an icalparameter object.
parameter | The icalparameter to free |
This method needs to be used on all parameter objects returned from any of the _new()
methods including icalparameter_new(), icalparameter_new_clone(), icalparameter_new_from_string() and icalparameter_new_from_value_string(), when they are not needed anymore and to be released.
```c icalparameter *param = icalparameter_new();
if(param) { // use param... }
// after use, release it icalparameter_free(param);
const char* icalparameter_get_iana_name | ( | icalparameter * | param | ) |
Returns the IANA name of param.
param | The icalparameter whose IANA name is to be returned |
NULL
and sets icalerrno to ICAL_BADARG_ERROR when a NULL
is passed instead of an icalparameter.```c // creates new parameter icalparameter *param = icalparameter_new();
// sets iana name icalparameter_set_iana_name(param, "X-TEST");
// compare iana name assert(0 == strcmp(icalparameter_get_iana_name(param), "X-TEST"));
icalparameter_free(param);
const char* icalparameter_get_iana_value | ( | icalparameter * | param | ) |
Returns the IANA value of param.
param | The icalparameter whose value is to be returned |
NULL
and sets icalerrno to ICAL_BADARG_ERROR when a NULL
is passed instead of an icalparameter.```c // create new parameter icalparameter *param = icalparameter_new_from_string("ROLE=ATTENDEE");
// set role to chair icalparameter_set_iana_value(param, "CHAIR");
// check that it worked assert(0 == strcmp(icalparameter_get_iana_value(param), "SUCCESS"));
// release memory icalparameter_free(param);
const char* icalparameter_get_xname | ( | icalparameter * | param | ) |
Returns the X-name of param.
param | The icalparameter whose X-name is to be returned |
NULL
and sets icalerrno to ICAL_BADARG_ERROR when a NULL
is passed instead of an icalparameter.```c // creates new parameter icalparameter *param = icalparameter_new();
// sets xname icalparameter_set_xname(param, "X-TEST");
// compare xname assert(0 == strcmp(icalparameter_get_xname(param), "X-TEST"));
icalparameter_free(param);
const char* icalparameter_get_xvalue | ( | icalparameter * | param | ) |
Returns the X-value of param.
param | The icalparameter whose X-value is to be returned |
NULL
and sets icalerrno to ICAL_BADARG_ERROR when a NULL
is passed instead of an icalparameter.```c // create new parameter icalparameter *param = icalparameter_new_from_string("X-TEST=FAIL");
// set test to success icalparameter_set_xvalue(param, "SUCCESS");
// check that it worked assert(0 == strcmp(icalparameter_get_xvalue(param), "SUCCESS"));
// release memory icalparameter_free(param);
int icalparameter_has_same_name | ( | icalparameter * | param1, |
icalparameter * | param2 | ||
) |
Determines if two parameters have the same name.
param1 | First parameter to compare |
param2 | Second parameter to compare |
NULL
, it returns 0 and sets icalerrno to ICAL_BADARG_ERROR.```c // create two parameters icalparameter *param1 = icalparameter_new_from_string("ROLE=CHAIR"); icalparameter *param2 = icalparameter_new_from_string("EMAIL=mailto@example.com");
// compare parameter names for equality assert(icalparameter_has_same_name(param1, param2) == 0);
// release memory icalparameter_free(param1); icalparameter_free(param2);
icalparameter_kind icalparameter_isa | ( | icalparameter * | parameter | ) |
Returns the icalparameter_kind of parameter.
parameter | The icalparameter whose kind to determine |
Error handling Returns ICAL_NO_PARAMETER when passed NULL.
Usage
int icalparameter_isa_parameter | ( | void * | param | ) |
Determines if the given param is an icalparameter
param | The libical-originated object to check |
Error handling When given a NULL
object, it returns 0.
Usage
```c // create parameter icalparameter *param = icalparameter_new_from_string("ROLE=CHAIR");
// check if it's a parameter assert(icalparameter_isa_parameter(param));
// release memory icalparameter_free(param);
int icalparameter_kind_is_valid | ( | const icalparameter_kind | kind | ) |
Checks the validity of a icalparameter_kind.
kind | The icalparameter_kind |
const char* icalparameter_kind_to_string | ( | icalparameter_kind | kind | ) |
Returns a string representing the given icalparameter_kind.
kind | The icalparameter_kind |
NULL
.icalparameter* icalparameter_new | ( | icalparameter_kind | kind | ) |
Creates new icalparameter object.
kind | The kind of icalparameter to create. |
NULL
and sets icalerrno to ICAL_NEWFAILED_ERROR.```c // create new parameter icalparameter *parameter = icalparameter_new();
if(parameter) { // use parameter ... }
// release parameter icalparameter_free(parameter);
icalparameter* icalparameter_new_clone | ( | icalparameter * | p | ) |
Creates new icalparameter as a clone of the given one.
p | The existing, non-NULL parameter to clone. |
NULL
, it returns NULL
and sets icalerrno to ICAL_BADARG_ERROR. If there was an internal error cloning the data, it returns NULL
without reporting any error in icalerrno.```x // create an icalparameter icalparameter *param = icalparameter_new_from_string("ROLE=CHAIR");
// clone the parameter icalparameter *clone = icalparameter_new_clone(param);
if(clone) { // use clone ... }
// release parameters icalparameter_free(param); icalparameter_free(clone);
icalparameter* icalparameter_new_from_string | ( | const char * | value | ) |
Creates new icalparameter object from string.
value | The string from which to create the icalparameter, in the form "PARAMNAME=VALUE" |
NULL
and sets icalerrno to ICAL_NEWFAILED_ERROR. If value was NULL
, it returns NULL
and sets icalerrno to ICAL_BADARG_ERROR. If value was malformed, it returns NULL
and sets icalerrno to ICAL_MALFORMEDDATA_ERROR.```c icalparameter *param = icalparameter_new_from_string("ROLE=CHAIR");
if(param) { // use param ... }
icalparameter_free(param);
icalparameter* icalparameter_new_from_value_string | ( | icalparameter_kind | kind, |
const char * | value | ||
) |
Creates new icalparameter of a given kind with a given value.
kind | The kind of icalparameter to create |
value | The value of the parameter |
NULL
, it returns NULL
and sets icalerrno to ICAL_BADARG_ERROR.```c // create new parameter icalparameter *param; param = icalparameter_new_from_value_string(ICAL_ROLE_PARAMETER, "CHAIR");
// check parameter assert(0 == strcmp(icalparameter_get_iana_name(param), "ROLE")); assert(0 == strcmp(icalparameter_get_iana_value(param), "CHAIR"));
// release memory icalparameter_free(param);
void icalparameter_set_iana_name | ( | icalparameter * | param, |
const char * | v | ||
) |
Sets the IANA name of param to v.
param | The icalparameter to change |
v | The IANA name to set param to |
NULL
, it sets :calerrno to ICAL_BARARG_ERROR. If there is an error acquiring memory, it sets errno
to ENOMEM
.```c // creates new parameter icalparameter *param = icalparameter_new();
// sets iana name icalparameter_set_iana_name(param, "ROLE");
// compare iana name assert(0 == strcmp(icalparameter_get_iana_name(param), "X-TEST"));
icalparameter_free(param);
void icalparameter_set_iana_value | ( | icalparameter * | param, |
const char * | v | ||
) |
Sets the IANA value of param to v.
param | The icalparameter to change |
v | The IANA value to set param to |
NULL
, it sets icalerrno to ICAL_BARARG_ERROR. If there is an error acquiring memory, it sets errno
to ENOMEM
.```c // create new parameter icalparameter *param = icalparameter_new_from_string("ROLE=ATTENDEE");
// set role to chair icalparameter_set_iana_value(param, "CHAIR");
// check that it worked assert(0 == strcmp(icalparameter_get_iana_value(param), "SUCCESS"));
// release memory icalparameter_free(param);
void icalparameter_set_xname | ( | icalparameter * | param, |
const char * | v | ||
) |
Sets the X-name of param to v.
param | The icalparameter to change |
v | The X-name to set param to |
NULL
, it sets icalerrno to ICAL_BARARG_ERROR. If there is an error acquiring memory, it sets errno
to ENOMEM
.```c // creates new parameter icalparameter *param = icalparameter_new();
// sets xname icalparameter_set_xname(param, "X-TEST");
// compare xname assert(0 == strcmp(icalparameter_get_xname(param), "X-TEST"));
icalparameter_free(param);
void icalparameter_set_xvalue | ( | icalparameter * | param, |
const char * | v | ||
) |
Sets the X-value of param to v.
param | The icalparameter to change |
v | The X-value to set param to |
NULL
, it sets icalerrno to ICAL_BARARG_ERROR. If there is an error acquiring memory, it sets errno
to ENOMEM
.```c // create new parameter icalparameter *param = icalparameter_new_from_string("X-TEST=FAIL");
// set test to success icalparameter_set_xvalue(param, "SUCCESS");
// check that it worked assert(0 == strcmp(icalparameter_get_xvalue(param), "SUCCESS"));
// release memory icalparameter_free(param);
icalparameter_kind icalparameter_string_to_kind | ( | const char * | string | ) |
Returns the icalparameter_kind for a given string.
string | A string describing an icalparameter_kind |
NULL
. If it can't find the parameter, depending on the ical_get_unknown_token_handling_setting(), it returns either ICAL_NO_PARAMETER or ICAL_IANA_PARAMETER.