icalproperty.h File Reference

Go to the source code of this file.

Data Structures
struct	icalparamiter

Typedefs
typedef struct icalparamiter	icalparamiter

Functions
icalproperty *	icalparameter_get_parent (const icalparameter *param)
void	icalparameter_set_parent (icalparameter *param, icalproperty *property)
icalvalue_kind	icalparameter_value_to_value_kind (icalparameter_value value)
icalparameter *	icalparamiter_deref (icalparamiter *i)
icalparameter *	icalparamiter_next (icalparamiter *i)
const char *	icalproperty_action_to_string (icalproperty_action)
void	icalproperty_add_parameter (icalproperty *prop, icalparameter *parameter)
void	icalproperty_add_parameters (struct icalproperty_impl *prop, va_list args)
const char *	icalproperty_as_ical_string (icalproperty *prop)
char *	icalproperty_as_ical_string_r (icalproperty *prop)
icalparamiter	icalproperty_begin_parameter (icalproperty *property, icalparameter_kind kind)
const char *	icalproperty_class_to_string (icalproperty_class)
icalproperty *	icalproperty_clone (const icalproperty *old)
	Deeply clones an icalproperty.
int	icalproperty_count_parameters (const icalproperty *prop)
bool	icalproperty_enum_belongs_to_property (icalproperty_kind kind, int e)
const char *	icalproperty_enum_to_string (int e)
char *	icalproperty_enum_to_string_r (int e)
void	icalproperty_free (icalproperty *prop)
bool	icalproperty_get_allow_empty_properties (void)
icalparameter *	icalproperty_get_first_parameter (icalproperty *prop, icalparameter_kind kind)
const char *	icalproperty_get_iana_name (const icalproperty *prop)
icalparameter *	icalproperty_get_next_parameter (icalproperty *prop, icalparameter_kind kind)
const char *	icalproperty_get_parameter_as_string (icalproperty *prop, const char *name)
char *	icalproperty_get_parameter_as_string_r (icalproperty *prop, const char *name)
const char *	icalproperty_get_property_name (const icalproperty *prop)
char *	icalproperty_get_property_name_r (const icalproperty *prop)
icalvalue *	icalproperty_get_value (const icalproperty *prop)
const char *	icalproperty_get_value_as_string (const icalproperty *prop)
char *	icalproperty_get_value_as_string_r (const icalproperty *prop)
const char *	icalproperty_get_x_name (const icalproperty *prop)
icalproperty_kind	icalproperty_isa (const icalproperty *property)
bool	icalproperty_isa_property (void *property)
int	icalproperty_kind_and_string_to_enum (const int kind, const char *str)
bool	icalproperty_kind_is_valid (const icalproperty_kind kind)
const char *	icalproperty_kind_to_string (icalproperty_kind kind)
icalvalue_kind	icalproperty_kind_to_value_kind (icalproperty_kind kind)
const char *	icalproperty_method_to_string (icalproperty_method method)
icalproperty *	icalproperty_new (icalproperty_kind kind)
icalproperty *	icalproperty_new_from_string (const char *str)
void	icalproperty_normalize (icalproperty *prop)
const char *	icalproperty_participanttype_to_string (icalproperty_participanttype)
void	icalproperty_remove_parameter_by_kind (icalproperty *prop, icalparameter_kind kind)
	Removes all parameters with the specified kind.
void	icalproperty_remove_parameter_by_name (icalproperty *prop, const char *name)
	Removes all parameters with the specified name.
void	icalproperty_remove_parameter_by_ref (icalproperty *prop, icalparameter *param)
	Removes the specified parameter reference from the property.
const char *	icalproperty_resourcetype_to_string (icalproperty_resourcetype)
void	icalproperty_set_allow_empty_properties (bool enable)
void	icalproperty_set_iana_name (icalproperty *prop, const char *name)
void	icalproperty_set_parameter (icalproperty *prop, icalparameter *parameter)
void	icalproperty_set_parameter_from_string (icalproperty *prop, const char *name, const char *value)
void	icalproperty_set_value (icalproperty *prop, icalvalue *value)
void	icalproperty_set_value_from_string (icalproperty *prop, const char *str, const char *type)
void	icalproperty_set_x_name (icalproperty *prop, const char *name)
const char *	icalproperty_status_to_string (icalproperty_status)
icalproperty_action	icalproperty_string_to_action (const char *string)
icalproperty_class	icalproperty_string_to_class (const char *string)
icalproperty_kind	icalproperty_string_to_kind (const char *string)
icalproperty_method	icalproperty_string_to_method (const char *str)
icalproperty_participanttype	icalproperty_string_to_participanttype (const char *string)
icalproperty_resourcetype	icalproperty_string_to_resourcetype (const char *string)
icalproperty_status	icalproperty_string_to_status (const char *string)
icalproperty_transp	icalproperty_string_to_transp (const char *string)
const char *	icalproperty_transp_to_string (icalproperty_transp)
icalproperty_kind	icalproperty_value_kind_to_kind (icalvalue_kind kind)
icalproperty *	icalvalue_get_parent (const icalvalue *value)
void	icalvalue_set_parent (icalvalue *value, icalproperty *property)

Function Documentation

icalparameter_get_parent()

icalproperty * icalparameter_get_parent

(

const icalparameter *

param

)

Returns the parent icalproperty for the specified icalparameter.

Since

3.0

icalparameter_set_parent()

void icalparameter_set_parent	(	icalparameter *	param,
		icalproperty *	property )

Sets the parent icalproperty for the specified icalparameter.

Since

3.0

icalproperty_clone()

icalproperty * icalproperty_clone

(

const icalproperty *

old

)

Deeply clones an icalproperty.

Returns a pointer to the memory for the newly cloned icalproperty.

Since

4.0

icalproperty_get_allow_empty_properties()

bool icalproperty_get_allow_empty_properties

(

void

)

Returns if empty properties are allowed; else are replaced with X-LIC-ERROR properties.

Returns

true if empty properties are allowed; else returns false

Since

4.0

icalproperty_get_iana_name()

const char * icalproperty_get_iana_name

(

const icalproperty *

prop

)

Gets the IANA name of the specified icalproperty.

Parameters

prop	a pointer to a valid icalproperty

Returns

a pointer to a char string containing the comp IANA name; will be NULL if the name has yet to be specified.

Since

4.0

icalproperty_get_property_name()

const char * icalproperty_get_property_name

(

const icalproperty *

prop

)

Returns the name of the property – the type name converted to a string, or the value of _get_x_name if the type is and X property

icalproperty_kind_is_valid()

bool icalproperty_kind_is_valid

(

const icalproperty_kind

kind

)

Check validity of a specific icalproperty_kind

icalproperty_normalize()

void icalproperty_normalize

(

icalproperty *

prop

)

Normalizes (reorders and sorts the parameters) the specified icalproperty.

Since

3.0

icalproperty_remove_parameter_by_kind()

void icalproperty_remove_parameter_by_kind	(	icalproperty *	prop,
		icalparameter_kind	kind )

Removes all parameters with the specified kind.

Parameters

prop	A valid icalproperty.
kind	The kind to remove (ex. ICAL_TZID_PARAMETER)

See icalproperty_remove_parameter_by_name() and icalproperty_remove_parameter_by_ref() for alternate ways of removing parameters

icalproperty_remove_parameter_by_name()

void icalproperty_remove_parameter_by_name	(	icalproperty *	prop,
		const char *	name )

Removes all parameters with the specified name.

Parameters

prop	A valid icalproperty.
name	The name of the parameter to remove

This function removes parameters with the given name. The name corresponds to either a built-in name (TZID, etc.) or the name of an extended parameter (X-FOO)

See icalproperty_remove_parameter_by_kind() and icalproperty_remove_parameter_by_ref() for alternate ways of removing parameters

icalproperty_remove_parameter_by_ref()

void icalproperty_remove_parameter_by_ref	(	icalproperty *	prop,
		icalparameter *	param )

Removes the specified parameter reference from the property.

Parameters

prop	A valid icalproperty.
param	A reference to a specific icalparameter.

This function removes the specified parameter reference from the property.

icalproperty_set_allow_empty_properties()

void icalproperty_set_allow_empty_properties

(

bool

enable

)

Sets if empty properties are permitted.

Determines the library behavior whenever an empty property is encountered. When not set (the default) empty properties are replaced with X-LIC-ERROR properties. Otherwise, processing proceeds normally and the property value will be empty.

Parameters

enable

If true, libical allows empty properties; otherwise empty properties are replaced by X-LIC-ERROR properties.

Note that if icalerror_get_errors_are_fatal is also true a SIGABRT will be raised whenever an empty property is encountered.

Since

4.0

icalproperty_set_iana_name()

void icalproperty_set_iana_name	(	icalproperty *	prop,
		const char *	name )

Sets the IANA name for an icalproperty.

Parameters

prop	a pointer to a valid icalproperty
name	a pointer to char string containing the IANA name.

Since

4.0

icalvalue_get_parent()

icalproperty * icalvalue_get_parent

(

const icalvalue *

value

)

Returns the parent icalproperty for the specified icalvalue.

Since

3.0

icalvalue_set_parent()

void icalvalue_set_parent	(	icalvalue *	value,
		icalproperty *	property )

Sets the parent icalproperty for the specified icalvalue.