vcardproperty.c File Reference

Implements the data structure representing vCard properties. More...

Go to the source code of this file.

Functions
void	vcardproperty_add_parameter (vcardproperty *p, vcardparameter *parameter)
void	vcardproperty_add_parameters (vcardproperty *prop, va_list args)
void	vcardproperty_add_type_parameter (vcardproperty *prop, vcardenumarray_element *type)
const char *	vcardproperty_as_vcard_string (vcardproperty *prop)
char *	vcardproperty_as_vcard_string_r (vcardproperty *prop)
vcardproperty *	vcardproperty_clone (const vcardproperty *old)
	Deeply clones an vcardproperty. More...
int	vcardproperty_count_parameters (const vcardproperty *prop)
void	vcardproperty_free (vcardproperty *p)
vcardparameter *	vcardproperty_get_first_parameter (vcardproperty *p, vcardparameter_kind kind)
const char *	vcardproperty_get_group (const vcardproperty *prop)
vcardparameter *	vcardproperty_get_next_parameter (vcardproperty *p, vcardparameter_kind kind)
const char *	vcardproperty_get_parameter_as_string (vcardproperty *prop, const char *name)
char *	vcardproperty_get_parameter_as_string_r (vcardproperty *prop, const char *name)
vcardcomponent *	vcardproperty_get_parent (const vcardproperty *property)
	Returns the parent vcard for the specified property.
const char *	vcardproperty_get_property_name (const vcardproperty *prop)
char *	vcardproperty_get_property_name_r (const vcardproperty *prop)
vcardvalue *	vcardproperty_get_value (const vcardproperty *prop)
const char *	vcardproperty_get_value_as_string (const vcardproperty *prop)
char *	vcardproperty_get_value_as_string_r (const vcardproperty *prop)
const char *	vcardproperty_get_x_name (const vcardproperty *prop)
vcardproperty_kind	vcardproperty_isa (const vcardproperty *p)
bool	vcardproperty_isa_property (void *property)
vcardproperty *	vcardproperty_new (vcardproperty_kind kind)
vcardproperty *	vcardproperty_new_from_string (const char *str)
struct vcardproperty_impl *	vcardproperty_new_impl (vcardproperty_kind kind)
void	vcardproperty_normalize (vcardproperty *prop)
void	vcardproperty_remove_parameter_by_kind (vcardproperty *prop, vcardparameter_kind kind)
	Removes all parameters with the specified kind. More...
void	vcardproperty_remove_parameter_by_name (vcardproperty *prop, const char *name)
	Removes all parameters with the specified name. More...
void	vcardproperty_remove_parameter_by_ref (vcardproperty *prop, vcardparameter *parameter)
	Removes the specified parameter reference from the property. More...
void	vcardproperty_set_group (vcardproperty *prop, const char *group)
void	vcardproperty_set_parameter (vcardproperty *prop, vcardparameter *parameter)
void	vcardproperty_set_parameter_from_string (vcardproperty *prop, const char *name, const char *value)
void	vcardproperty_set_parent (vcardproperty *property, vcardcomponent *comp)
	Sets the parent vcard for the specified vcardproperty property. More...
void	vcardproperty_set_value (vcardproperty *p, vcardvalue *value)
void	vcardproperty_set_value_from_string (vcardproperty *prop, const char *str, const char *type)
void	vcardproperty_set_x_name (vcardproperty *prop, const char *name)

Detailed Description

Implements the data structure representing vCard properties.

Definition in file vcardproperty.c.

Function Documentation

vcardproperty* vcardproperty_clone

(

const vcardproperty *

old

)

Deeply clones an vcardproperty.

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

Since

4.0

Definition at line 87 of file vcardproperty.c.

const char* vcardproperty_get_property_name

(

const vcardproperty *

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

Definition at line 951 of file vcardproperty.c.

void vcardproperty_normalize

(

vcardproperty *

prop

)

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

Since

3.0

Definition at line 1012 of file vcardproperty.c.

void vcardproperty_remove_parameter_by_kind	(	vcardproperty *	prop,
		vcardparameter_kind	kind
	)

Removes all parameters with the specified kind.

Parameters

prop	A valid vcardproperty.
kind	The kind to remove (ex. VCARD_TZ_PARAMETER)

See vcardproperty_remove_parameter_by_name() and vcardproperty_remove_parameter_by_ref() for alternate ways of removing parameters

Definition at line 689 of file vcardproperty.c.

void vcardproperty_remove_parameter_by_name	(	vcardproperty *	prop,
		const char *	name
	)

Removes all parameters with the specified name.

Parameters

prop	A valid vcardproperty.
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 vcardproperty_remove_parameter_by_kind() and vcardproperty_remove_parameter_by_ref() for alternate ways of removing parameters

Definition at line 706 of file vcardproperty.c.

void vcardproperty_remove_parameter_by_ref	(	vcardproperty *	prop,
		vcardparameter *	param
	)

Removes the specified parameter reference from the property.

Parameters

prop	A valid vcardproperty.
param	A reference to a specific vcardparameter.

This function removes the specified parameter reference from the property.

Definition at line 736 of file vcardproperty.c.

void vcardproperty_set_parent	(	vcardproperty *	property,
		vcardcomponent *	comp
	)

Sets the parent vcard for the specified vcardproperty property.

Since

3.0

Definition at line 992 of file vcardproperty.c.