Defines the data structure representing iCalendar properties. More...

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)
const char *	icalproperty_action_to_string (icalproperty_action action)
void	icalproperty_add_parameter (icalproperty prop, icalparameter parameter)
void	icalproperty_add_parameters (icalproperty *prop, va_list args)
const char *	icalproperty_as_ical_string (icalproperty *prop)
char *	icalproperty_as_ical_string_r (icalproperty *prop)
const char *	icalproperty_class_to_string (icalproperty_class propclass)
icalproperty *	icalproperty_clone (const icalproperty *old)
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 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 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 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 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)

Detailed Description

Defines the data structure representing iCalendar properties.

Definition in file icalproperty.h.

Function Documentation

◆ icalparameter_get_parent()

icalproperty * icalparameter_get_parent ( const icalparameter * param )

Gets the parent icalproperty of an icalparameter.

Parameters

param a pointer to the icalparameter

Returns: the parent icalproperty for the specified icalparameter.

Since: 3.0

Definition at line 371 of file icalparameter.c.

◆ icalparameter_set_parent()

void icalparameter_set_parent	(	icalparameter *	param,
		icalproperty *	property )

Sets the parent icalproperty for the specified icalparameter.

Parameters

param	a pointer to a valid icalparameter
property	a pointer to a presumably valid icalproperty to use

Since: 3.0

Definition at line 364 of file icalparameter.c.

◆ icalparameter_value_to_value_kind()

icalvalue_kind icalparameter_value_to_value_kind ( icalparameter_value value )

Converts an icalparameter_value to an icalvalue_kind.

Parameters

value the icalparameter_value to use

Returns: the icalvalue_kind conversion from value; returns ICAL_NO_VALUE if value is invalid.

◆ icalproperty_action_to_string()

const char * icalproperty_action_to_string ( icalproperty_action action )

Converts an icalproperty_action to its string representation.

Parameters

action is the icalproperty_action to use

Returns: a pointer to a char string containing the string representation of the specified icalproperty_action.

◆ icalproperty_add_parameter()

void icalproperty_add_parameter	(	icalproperty *	prop,
		icalparameter *	parameter )

Adds a parameter to the specified icalproperty.

No error checking is performed by this function.

Parameters

prop	a pointer to a valid icalproperty
parameter	a pointer to a presumably valid icalparameter

Definition at line 488 of file icalproperty.c.

◆ icalproperty_add_parameters()

void icalproperty_add_parameters	(	icalproperty *	prop,
		va_list	args )

Adds a list of parameter to the specified icalproperty.

Parameters

prop	a pointer to a valid icalproperty.
args	a va_list of pointers that presumably point to list of valid icalparameters.

If any item in va_list points to an illegal icalparameter the internal library icalerrno is set to ICAL_BADARG_ERROR.

Any item in va_list points to an icalvalue is ignored.

Definition at line 77 of file icalproperty.c.

◆ icalproperty_as_ical_string()

const char * icalproperty_as_ical_string ( icalproperty * prop )

Stringify an icalproperty.

Parameters

prop	a pointer to an icalproperty

Returns: a pointer to a char string containing the string representation of prop. NULL is returned is prop is invalid.

See also: icalproperty_as_ical_string_r

Definition at line 360 of file icalproperty.c.

◆ icalproperty_as_ical_string_r()

char * icalproperty_as_ical_string_r ( icalproperty * prop )

Stringify an icalproperty.

Parameters

prop	a pointer to an icalproperty

Returns: a pointer to a char string containing the string representation of prop. NULL is returned is prop is invalid.

See also: icalproperty_as_ical_string

Definition at line 369 of file icalproperty.c.

◆ icalproperty_class_to_string()

const char * icalproperty_class_to_string ( icalproperty_class propclass )

Converts an icalproperty_class to its string representation.

Parameters

propclass is the icalproperty_class to use

Returns: a pointer to a char string containing the string representation of the specified icalproperty_class.

◆ icalproperty_clone()

icalproperty * icalproperty_clone ( const icalproperty * old )

Deeply clones an icalproperty.

Parameters

old	a pointer to the icalproperty to clone

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

Since: 4.0

Definition at line 100 of file icalproperty.c.

◆ icalproperty_count_parameters()

int icalproperty_count_parameters ( const icalproperty * prop )

Gets the number of parameter for a specified icalproperty.

Parameters

prop	a pointer to a valid icalproperty

Returns: the number of parameters attached to prop. Returns -1 if prop is NULL.

Definition at line 699 of file icalproperty.c.

◆ icalproperty_enum_belongs_to_property()

bool icalproperty_enum_belongs_to_property	(	icalproperty_kind	kind,
		int	e )

Determines if a integer ia a valid enum for a specified icalproperty_kind.

Parameters

kind	is the icalproperty_kind
e	is a an integer to validate as an enum of type icalproperty_kind

Returns: true if the specified integer is a valid enum for icalproperty_kind; false otherwise.

◆ icalproperty_enum_to_string()

const char * icalproperty_enum_to_string ( int e )

Converts an integer representing some icalproperty type to its string representation.

Parameters

e	is an integer between ICALPROPERTY_FIRST_ENUM and ICALPROPERTY_LAST_ENUM, inclusive.

Returns: a pointer to a char string containing the string representation of the specified icalproperty type.

See also: icalproperty_enum_to_string_r

◆ icalproperty_enum_to_string_r()

char * icalproperty_enum_to_string_r ( int e )

Converts an integer representing some icalproperty type to its string representation.

Parameters

e	is an integer between ICALPROPERTY_FIRST_ENUM and ICALPROPERTY_LAST_ENUM, inclusive.

Returns: a pointer to a char string containing the string representation of the specified icalproperty type.

See also: icalproperty_enum_to_string

◆ icalproperty_free()

void icalproperty_free ( icalproperty * prop )

Free the memory for an icalproperty.

Parameters

prop	a pointer to a valid icalproperty

Definition at line 184 of file icalproperty.c.

◆ 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

Definition at line 72 of file icalproperty.c.

◆ icalproperty_get_first_parameter()

icalparameter * icalproperty_get_first_parameter	(	icalproperty *	prop,
		icalparameter_kind	kind )

From the head position, iterates the icalparameter list attached to the specified icalproperty until the first icalparameter_kind is found.

Parameters

prop	a pointer to a valid icalproperty
kind	an icalparameter_kind to use for the search

Returns: a pointer to the first icalparameter found of icalparameter_kind kind ; NULL if no matches are found.

Definition at line 709 of file icalproperty.c.

◆ 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

Definition at line 883 of file icalproperty.c.

◆ icalproperty_get_next_parameter()

icalparameter * icalproperty_get_next_parameter	(	icalproperty *	prop,
		icalparameter_kind	kind )

From the current position, iterates the icalparameter list attached to the specified icalproperty until the next icalparameter_kind is found.

Parameters

prop	a pointer to a valid icalproperty
kind	an icalparameter_kind to use for the search

Returns: a pointer to the next icalparameter found of icalparamter_kind kind; NULL if no matches are found.

Definition at line 731 of file icalproperty.c.

◆ icalproperty_get_parameter_as_string()

const char * icalproperty_get_parameter_as_string	(	icalproperty *	prop,
		const char *	name )

Gets the parameter value for a specified icalproperty parameter.

Parameters

prop	a pointer to a valid icalproperty
name	a a pointer to a char string containing the name of icalparameter to use

Returns: a pointer to a char string containing the value for the specified icalparameter name; NULL is returned is name refers to an invalid icalproperty_kind.

See also: icalproperty_get_parameter_as_string_r

Definition at line 548 of file icalproperty.c.

◆ icalproperty_get_parameter_as_string_r()

char * icalproperty_get_parameter_as_string_r	(	icalproperty *	prop,
		const char *	name )

Gets the parameter value for a specified icalproperty parameter.

Parameters

prop	a pointer to a valid icalproperty
name	a pointer to a char string containing the name of icalparameter to use

Returns: a pointer to a char string containing the value for the specified icalparameter name; NULL is returned is name refers to an invalid icalproperty_kind.

See also: icalproperty_get_parameter_as_string

Definition at line 557 of file icalproperty.c.

◆ icalproperty_get_property_name()

const char * icalproperty_get_property_name ( const icalproperty * prop )

Gets the name of the specified icalproperty.

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.

Parameters

prop	a pointer to the icalproperty

Returns: a pointer to a string containing the icalproperty's name.

See also: icalproperty_get_property_name_r

Definition at line 891 of file icalproperty.c.

◆ icalproperty_get_property_name_r()

char * icalproperty_get_property_name_r ( const icalproperty * prop )

Gets the name of the specified icalproperty.

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.

Parameters

prop	a pointer to the icalproperty

Returns: a pointer to a string containing the icalproperty's name.

See also: icalproperty_get_property_name

Definition at line 900 of file icalproperty.c.

◆ icalproperty_get_value()

icalvalue * icalproperty_get_value ( const icalproperty * prop )

Gets the icalvalue for the specified icalproperty.

Parameters

prop	a pointer to a valid icalproperty

Returns: a pointer the prop icalvalue; or NULL if prop does not have an attached icalvalue yet.

Definition at line 822 of file icalproperty.c.

◆ icalproperty_get_value_as_string()

const char * icalproperty_get_value_as_string ( const icalproperty * prop )

Gets the icalvalue for the specified icalproperty as a char string.

Parameters

prop	a pointer to a valid icalproperty

Returns: a pointer the string-converted prop icalvalue; or NULL if prop does not have an attached icalvalue yet.

See also: icalproperty_get_value_as_string_r

Definition at line 829 of file icalproperty.c.

◆ icalproperty_get_value_as_string_r()

char * icalproperty_get_value_as_string_r ( const icalproperty * prop )

Gets the icalvalue for the specified icalproperty as a char string.

Parameters

prop	a pointer to a valid icalproperty

Returns: a pointer the string-converted prop icalvalue; or NULL if prop does not have an attached icalvalue yet.

See also: icalproperty_get_value_as_string

Definition at line 838 of file icalproperty.c.

◆ icalproperty_get_x_name()

const char * icalproperty_get_x_name ( const icalproperty * prop )

Gets the X-NAME icalproperty of the specified icalproperty.

Parameters

prop	a pointer to a valid icalproperty

Returns: a pointer to a char string containing the X-NAME property. Will be NULL if an X-NAME property has not been set yet.

Since: 3.0

Definition at line 862 of file icalproperty.c.

◆ icalproperty_isa()

icalproperty_kind icalproperty_isa ( const icalproperty * property )

Determines the icalproperty_kind of the specified icalproperty.

Parameters

property a pointer to valid icalproperty.

Returns: the icalproperty_kind of property; ICAL_NO_PROPERTY is returned if property is NULL.

Definition at line 467 of file icalproperty.c.

◆ icalproperty_isa_property()

bool icalproperty_isa_property ( void * property )

Determines if the specified pointer is an icalproperty pointer.

Just looks if the ::id member strncmps to "prop".

Parameters

property a pointer, presumably to an icalproperty.

Returns: true if the pointer looks like an icalproperty; false otherwise.

Definition at line 476 of file icalproperty.c.

◆ icalproperty_kind_and_string_to_enum()

int icalproperty_kind_and_string_to_enum	(	const int	kind,
		const char *	str )

Converts an integer representation of an icalvalue_kind enum along with a string representation of an icalproperty_kind to an integer representation of an icalproperty enum.

Parameters

kind	is a integer representation of an icalvalue_kind
str	is a non-NULL pointer to a char string containing the string representation of the icalproperty enum.

Returns: an integer representation of an icalproperty_kind enum; returns zero if kind is invalid.

◆ icalproperty_kind_is_valid()

bool icalproperty_kind_is_valid ( const icalproperty_kind kind )

Check validity of a specified icalproperty_kind.

Parameters

kind	is the icalproperty_kind

Returns: true if the specified icalproperty_kind is valid; false otherwise.

◆ icalproperty_kind_to_string()

const char * icalproperty_kind_to_string ( icalproperty_kind kind )

Converts an icalproperty_kind to its string representation.

Parameters

kind	is the icalproperty_kind to use

Returns: a pointer to a char string containing the string representation of the specified icalproperty_kind.

◆ icalproperty_kind_to_value_kind()

icalvalue_kind icalproperty_kind_to_value_kind ( icalproperty_kind kind )

Converts an icalproperty_kind to an icalvalue_kind.

Parameters

kind	is the icalproperty_kind to use

Returns: the icalvalue_kind from kind; returns ICAL_NO_VALUE if kind is invalid.

◆ icalproperty_method_to_string()

const char * icalproperty_method_to_string ( icalproperty_method method )

Converts an icalproperty_method to its string representation.

Parameters

method is the icalproperty_method to use

Returns: a pointer to a char string containing the string representation of the specified icalproperty_method.

◆ icalproperty_new()

icalproperty * icalproperty_new ( icalproperty_kind kind )

Construct a new icalproperty of the specified icalproperty_kind.

Parameters

kind	is the icalproperty_kind to use

Returns: a pointer to the newly allocated icalproperty. The data structure contains all null values and is essentially invalid. Free the resulting memory with icalproperty_free.

Definition at line 91 of file icalproperty.c.

◆ icalproperty_new_from_string()

icalproperty * icalproperty_new_from_string ( const char * str )

Construct and populate a new icalproperty from a char string.

Parameters

str	a non-NULL pointer to the data used to populate the new icalproperty.

Returns: a pointer to the newly allocated icalproperty. Free the resulting memory with icalproperty_free.

Definition at line 138 of file icalproperty.c.

◆ icalproperty_normalize()

void icalproperty_normalize ( icalproperty * prop )

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

Parameters

prop	a pointer a valid icalproperty

Since: 3.0

Definition at line 953 of file icalproperty.c.

◆ icalproperty_participanttype_to_string()

const char * icalproperty_participanttype_to_string ( icalproperty_participanttype participanttype )

Converts an icalproperty_participanttype to its string representation.

Parameters

participanttype is the icalproperty_participanttype to use

Returns: a pointer to a char string containing the string representation of the specified icalproperty_participanttype.

◆ 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

Definition at line 632 of file icalproperty.c.

◆ 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

Definition at line 650 of file icalproperty.c.

◆ 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.

Definition at line 681 of file icalproperty.c.

◆ icalproperty_resourcetype_to_string()

const char * icalproperty_resourcetype_to_string ( icalproperty_resourcetype resourcetype )

Converts an icalproperty_resourcetype to its string representation.

Parameters

resourcetype is the icalproperty_resourcetype to use

Returns: a pointer to a char string containing the string representation of the specified icalproperty_resourcetype.

◆ 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

Definition at line 67 of file icalproperty.c.

◆ 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

Definition at line 869 of file icalproperty.c.

◆ icalproperty_set_parameter()

void icalproperty_set_parameter	(	icalproperty *	prop,
		icalparameter *	parameter )

Adds an icalparameter to an icalproperty.

No error checking is performed by this function.

Parameters

prop	a pointer to a valid icalproperty
parameter	a pointer to a presumably valid icalparameter

If parameter kind is already attached to prop then the old parameter is removed in favor of parameter.

Definition at line 496 of file icalproperty.c.

◆ icalproperty_set_parameter_from_string()

void icalproperty_set_parameter_from_string	(	icalproperty *	prop,
		const char *	name,
		const char *	value )

Sets a icalparameter from a string for the specified icalproperty.

Parameters

prop	a pointer to a valid icalproperty
name	a pointer to a char string containing the parameter name
value	a pointer to a char string containing the parameter value

If name refers to an invalid icalparameter_kind or value is illegal, then the internal library icalerrno is set to ICAL_BADARG_ERROR.

See also: icalproperty_get_parameter_as_string

Definition at line 515 of file icalproperty.c.

◆ icalproperty_set_value()

void icalproperty_set_value	(	icalproperty *	prop,
		icalvalue *	value )

Sets an icalvalue for the specified icalproperty.

Parameters

prop	a pointer to a valid icalproperty
value	a pointer to a valid icalvalue to use

If prop already has an icalvalue it will be replaced.

Definition at line 751 of file icalproperty.c.

◆ icalproperty_set_value_from_string()

void icalproperty_set_value_from_string	(	icalproperty *	prop,
		const char *	str,
		const char *	type )

Sets an icalvalue for the specified icalproperty from a char string..

Parameters

prop	a pointer to a valid icalproperty
str	a non-NULL pointer to char string to be converted to the icalvalue
type	a non-NULL pointer to a char string to be converted to an icalvalue_kind

If type string matches "NO" then the icalvalue_kind will be taken from an existing icalvalue (if one exists) or will use the default icalvalue_kind for the icalproperty.

If prop already has an icalvalue it will be replaced.

Definition at line 781 of file icalproperty.c.

◆ icalproperty_set_x_name()

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

Sets the X-NAME property of the specified icalproperty.

Parameters

prop	a pointer to a valid icalproperty
name	a pointer to a char string to use as the X-NAME

Definition at line 849 of file icalproperty.c.

◆ icalproperty_status_to_string()

const char * icalproperty_status_to_string ( icalproperty_status status )

Converts an icalproperty_status to its string representation.

Parameters

status is the icalproperty_status to use

Returns: a pointer to a char string containing the string representation of the specified icalproperty_status.

◆ icalproperty_string_to_action()

icalproperty_action icalproperty_string_to_action ( const char * string )

Converts a char string into an icalproperty_action.

Parameters

string a pointer to a char string containing the character representation of an icalproperty_action

Returns: the icalproperty_action associated with string. ICAL_ACTION_NONE is returned if string is invalid.

◆ icalproperty_string_to_class()

icalproperty_class icalproperty_string_to_class ( const char * string )

Converts a char string into an icalproperty_class.

Parameters

string a pointer to a char string containing the character representati on of an icalproperty_class_

Returns: the icalproperty_class associated with string. ICAL_CLASS_NONE is returned if string is invalid.

◆ icalproperty_string_to_kind()

icalproperty_kind icalproperty_string_to_kind ( const char * string )

Converts a char string into an icalproperty_kind.

Parameters

string a pointer to a char string containing the character representati on of an icalproperty_kind

Returns: the icalproperty_kind associated with string. ICAL_NO_PROPERTY is returned if string is invalid.

◆ icalproperty_string_to_method()

icalproperty_method icalproperty_string_to_method ( const char * str )

Converts a char string into an icalproperty_method.

Parameters

str	a pointer to a char string containing the character representati on of an icalproperty_method

Returns: the icalproperty_method associated with string. ICAL_METHOD_NONE is returned if str is invalid.

◆ icalproperty_string_to_participanttype()

icalproperty_participanttype icalproperty_string_to_participanttype ( const char * string )

Converts a char string into an icalproperty_participanttype.

Parameters

string a pointer to a char string containing the character representation of an icalproperty_participanttype

Returns: the icalproperty_participanttype associated with string. ICAL_PARTICIPANTTYPE_NONE is returned if string is invalid.

◆ icalproperty_string_to_resourcetype()

icalproperty_resourcetype icalproperty_string_to_resourcetype ( const char * string )

Converts a char string into an icalproperty_resourcetype.

Parameters

string a pointer to a char string containing the character representation of an icalproperty_resourcetype

Returns: the icalproperty_resourcetype associated with string. ICAL_RESOURCETYPE_NONE is returned if string is invalid.

◆ icalproperty_string_to_status()

icalproperty_status icalproperty_string_to_status ( const char * string )

Converts a char string into an icalproperty_status.

Parameters

string a pointer to a char string containing the character representation of an icalproperty_status

Returns: the icalproperty_status associated with string. ICAL_STATUS_NONE is returned if string is invalid.

◆ icalproperty_string_to_transp()

icalproperty_transp icalproperty_string_to_transp ( const char * string )

Converts a char string into an icalproperty_transp.

Parameters

string a pointer to a char string containing the character representation of an icalproperty_transp

Returns: the icalproperty_transp associated with string. ICAL_TRANSP_NONE is returned if string is invalid.

◆ icalproperty_transp_to_string()

const char * icalproperty_transp_to_string ( icalproperty_transp transp )

Converts an icalproperty_transp to its string representation.

Parameters

transp is the icalproperty_transp to use

Returns: a pointer to a char string containing the string representation of the specified icalproperty_transp.

◆ icalproperty_value_kind_to_kind()

icalproperty_kind icalproperty_value_kind_to_kind ( icalvalue_kind kind )

Converts an icalvalue_kind to an icalproperty_kind.

Parameters

kind	is the icalvalue_kind to use

Returns: the icalproperty_kind from kind; returns ICAL_NO_PROPERTY if kind is invalid.

◆ icalvalue_get_parent()

icalproperty * icalvalue_get_parent ( const icalvalue * value )

Gets the parent icalproperty of the specified icalvalue.

Parameters

value a pointer to the icalvalue

Returns: the parent icalproperty for the specified icalvalue.

Since: 3.0

Definition at line 1548 of file icalvalue.c.

◆ icalvalue_set_parent()

void icalvalue_set_parent	(	icalvalue *	value,
		icalproperty *	property )

Sets the parent icalproperty for the specified icalvalue.

Parameters

value	a pointer to a valid icalvalue
property	a pointer to a presumably valid icalproperty to use

Definition at line 1541 of file icalvalue.c.

Functions

Detailed Description

Function Documentation

◆ icalparameter_get_parent()

◆ icalparameter_set_parent()

◆ icalparameter_value_to_value_kind()

◆ icalproperty_action_to_string()

◆ icalproperty_add_parameter()

◆ icalproperty_add_parameters()

◆ icalproperty_as_ical_string()

◆ icalproperty_as_ical_string_r()

◆ icalproperty_class_to_string()

◆ icalproperty_clone()

◆ icalproperty_count_parameters()

◆ icalproperty_enum_belongs_to_property()

◆ icalproperty_enum_to_string()

◆ icalproperty_enum_to_string_r()

◆ icalproperty_free()

◆ icalproperty_get_allow_empty_properties()

◆ icalproperty_get_first_parameter()

◆ icalproperty_get_iana_name()

◆ icalproperty_get_next_parameter()

◆ icalproperty_get_parameter_as_string()

◆ icalproperty_get_parameter_as_string_r()

◆ icalproperty_get_property_name()

◆ icalproperty_get_property_name_r()

◆ icalproperty_get_value()

◆ icalproperty_get_value_as_string()

◆ icalproperty_get_value_as_string_r()

◆ icalproperty_get_x_name()

◆ icalproperty_isa()

◆ icalproperty_isa_property()

◆ icalproperty_kind_and_string_to_enum()

◆ icalproperty_kind_is_valid()

◆ icalproperty_kind_to_string()

◆ icalproperty_kind_to_value_kind()

◆ icalproperty_method_to_string()

◆ icalproperty_new()

◆ icalproperty_new_from_string()

◆ icalproperty_normalize()

◆ icalproperty_participanttype_to_string()

◆ icalproperty_remove_parameter_by_kind()

◆ icalproperty_remove_parameter_by_name()

◆ icalproperty_remove_parameter_by_ref()

◆ icalproperty_resourcetype_to_string()

◆ icalproperty_set_allow_empty_properties()

◆ icalproperty_set_iana_name()

◆ icalproperty_set_parameter()

◆ icalproperty_set_parameter_from_string()

◆ icalproperty_set_value()

◆ icalproperty_set_value_from_string()

◆ icalproperty_set_x_name()

◆ icalproperty_status_to_string()

◆ icalproperty_string_to_action()

◆ icalproperty_string_to_class()

◆ icalproperty_string_to_kind()

◆ icalproperty_string_to_method()

◆ icalproperty_string_to_participanttype()

◆ icalproperty_string_to_resourcetype()

◆ icalproperty_string_to_status()

◆ icalproperty_string_to_transp()

◆ icalproperty_transp_to_string()

◆ icalproperty_value_kind_to_kind()

◆ icalvalue_get_parent()

◆ icalvalue_set_parent()