vcardproperty.h File Reference

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

Go to the source code of this file.

Functions
vcardproperty *	vcardparameter_get_parent (const vcardparameter *param)
void	vcardparameter_set_parent (vcardparameter *param, vcardproperty *property)
vcardvalue_kind	vcardparameter_value_to_value_kind (vcardparameter_value value)
void	vcardproperty_add_parameter (vcardproperty *prop, vcardparameter *parameter)
void	vcardproperty_add_parameters (struct vcardproperty_impl *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.
int	vcardproperty_count_parameters (const vcardproperty *prop)
bool	vcardproperty_enum_belongs_to_property (vcardproperty_kind kind, int e)
const char *	vcardproperty_enum_to_string (int e)
char *	vcardproperty_enum_to_string_r (int e)
void	vcardproperty_free (vcardproperty *prop)
vcardparameter *	vcardproperty_get_first_parameter (vcardproperty *prop, vcardparameter_kind kind)
const char *	vcardproperty_get_group (const vcardproperty *prop)
vcardparameter *	vcardproperty_get_next_parameter (vcardproperty *prop, 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)
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)
bool	vcardproperty_is_multivalued (vcardproperty_kind pkind)
bool	vcardproperty_is_structured (vcardproperty_kind pkind)
vcardproperty_kind	vcardproperty_isa (const vcardproperty *property)
bool	vcardproperty_isa_property (void *property)
int	vcardproperty_kind_and_string_to_enum (const int kind, const char *str)
bool	vcardproperty_kind_is_valid (const vcardproperty_kind kind)
const char *	vcardproperty_kind_to_string (vcardproperty_kind kind)
vcardvalue_kind	vcardproperty_kind_to_value_kind (vcardproperty_kind kind)
vcardproperty *	vcardproperty_new (vcardproperty_kind kind)
vcardproperty *	vcardproperty_new_from_string (const char *str)
void	vcardproperty_normalize (vcardproperty *prop)
void	vcardproperty_remove_parameter_by_kind (vcardproperty *prop, vcardparameter_kind kind)
	Removes all parameters with the specified kind.
void	vcardproperty_remove_parameter_by_name (vcardproperty *prop, const char *name)
	Removes all parameters with the specified name.
void	vcardproperty_remove_parameter_by_ref (vcardproperty *prop, vcardparameter *param)
	Removes the specified parameter reference from the property.
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_value (vcardproperty *prop, 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)
vcardproperty_kind	vcardproperty_string_to_kind (const char *string)
vcardproperty_kind	vcardproperty_value_kind_to_kind (vcardvalue_kind kind)
vcardproperty *	vcardvalue_get_parent (const vcardvalue *value)
void	vcardvalue_set_parent (vcardvalue *value, vcardproperty *property)

Detailed Description

Defines the data structure representing vCard properties.

Definition in file vcardproperty.h.

Function Documentation

vcardparameter_get_parent()

vcardproperty * vcardparameter_get_parent

(

const vcardparameter *

param

)

Returns the parent vcardproperty for the specified vcardparameter.

Since

3.0

Definition at line 390 of file vcardparameter.c.

vcardparameter_set_parent()

void vcardparameter_set_parent	(	vcardparameter *	param,
		vcardproperty *	property )

Sets the parent vcardproperty for the specified vcardparameter.

Since

3.0

Definition at line 383 of file vcardparameter.c.

vcardproperty_add_parameter()

void vcardproperty_add_parameter	(	vcardproperty *	prop,
		vcardparameter *	parameter )

Definition at line 551 of file vcardproperty.c.

vcardproperty_add_type_parameter()

void vcardproperty_add_type_parameter	(	vcardproperty *	prop,
		vcardenumarray_element *	type )

Definition at line 1127 of file vcardproperty.c.

vcardproperty_as_vcard_string()

const char * vcardproperty_as_vcard_string

(

vcardproperty *

prop

)

Definition at line 419 of file vcardproperty.c.

vcardproperty_as_vcard_string_r()

char * vcardproperty_as_vcard_string_r

(

vcardproperty *

prop

)

Definition at line 428 of file vcardproperty.c.

vcardproperty_clone()

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.

vcardproperty_count_parameters()

int vcardproperty_count_parameters

(

const vcardproperty *

prop

)

Definition at line 759 of file vcardproperty.c.

vcardproperty_free()

void vcardproperty_free

(

vcardproperty *

prop

)

Definition at line 171 of file vcardproperty.c.

vcardproperty_get_first_parameter()

vcardparameter * vcardproperty_get_first_parameter	(	vcardproperty *	prop,
		vcardparameter_kind	kind )

Definition at line 769 of file vcardproperty.c.

vcardproperty_get_group()

const char * vcardproperty_get_group

(

const vcardproperty *

prop

)

Definition at line 949 of file vcardproperty.c.

vcardproperty_get_next_parameter()

vcardparameter * vcardproperty_get_next_parameter	(	vcardproperty *	prop,
		vcardparameter_kind	kind )

Definition at line 791 of file vcardproperty.c.

vcardproperty_get_parameter_as_string()

const char * vcardproperty_get_parameter_as_string	(	vcardproperty *	prop,
		const char *	name )

Definition at line 611 of file vcardproperty.c.

vcardproperty_get_parameter_as_string_r()

char * vcardproperty_get_parameter_as_string_r	(	vcardproperty *	prop,
		const char *	name )

Definition at line 620 of file vcardproperty.c.

vcardproperty_get_property_name()

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 956 of file vcardproperty.c.

vcardproperty_get_property_name_r()

char * vcardproperty_get_property_name_r

(

const vcardproperty *

prop

)

Definition at line 965 of file vcardproperty.c.

vcardproperty_get_value()

vcardvalue * vcardproperty_get_value

(

const vcardproperty *

prop

)

Definition at line 883 of file vcardproperty.c.

vcardproperty_get_value_as_string()

const char * vcardproperty_get_value_as_string

(

const vcardproperty *

prop

)

Definition at line 890 of file vcardproperty.c.

vcardproperty_get_value_as_string_r()

char * vcardproperty_get_value_as_string_r

(

const vcardproperty *

prop

)

Definition at line 899 of file vcardproperty.c.

vcardproperty_get_x_name()

const char * vcardproperty_get_x_name

(

const vcardproperty *

prop

)

Definition at line 926 of file vcardproperty.c.

vcardproperty_isa()

vcardproperty_kind vcardproperty_isa

(

const vcardproperty *

property

)

Definition at line 530 of file vcardproperty.c.

vcardproperty_isa_property()

bool vcardproperty_isa_property

(

void *

property

)

Definition at line 539 of file vcardproperty.c.

vcardproperty_kind_is_valid()

bool vcardproperty_kind_is_valid

(

const vcardproperty_kind

kind

)

Check validity of a specific vcardproperty_kind

vcardproperty_new()

vcardproperty * vcardproperty_new

(

vcardproperty_kind

kind

)

Definition at line 78 of file vcardproperty.c.

vcardproperty_new_from_string()

vcardproperty * vcardproperty_new_from_string

(

const char *

str

)

Definition at line 125 of file vcardproperty.c.

vcardproperty_normalize()

void vcardproperty_normalize

(

vcardproperty *

prop

)

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

Since

3.0

Definition at line 1017 of file vcardproperty.c.

vcardproperty_remove_parameter_by_kind()

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 694 of file vcardproperty.c.

vcardproperty_remove_parameter_by_name()

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 711 of file vcardproperty.c.

vcardproperty_remove_parameter_by_ref()

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 741 of file vcardproperty.c.

vcardproperty_set_group()

void vcardproperty_set_group	(	vcardproperty *	prop,
		const char *	group )

Definition at line 933 of file vcardproperty.c.

vcardproperty_set_parameter()

void vcardproperty_set_parameter	(	vcardproperty *	prop,
		vcardparameter *	parameter )

Definition at line 559 of file vcardproperty.c.

vcardproperty_set_parameter_from_string()

void vcardproperty_set_parameter_from_string	(	vcardproperty *	prop,
		const char *	name,
		const char *	value )

Definition at line 578 of file vcardproperty.c.

vcardproperty_set_value()

void vcardproperty_set_value	(	vcardproperty *	prop,
		vcardvalue *	value )

Definition at line 811 of file vcardproperty.c.

vcardproperty_set_value_from_string()

void vcardproperty_set_value_from_string	(	vcardproperty *	prop,
		const char *	str,
		const char *	type )

Definition at line 842 of file vcardproperty.c.

vcardproperty_set_x_name()

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

Definition at line 910 of file vcardproperty.c.

vcardvalue_get_parent()

vcardproperty * vcardvalue_get_parent

(

const vcardvalue *

value

)

Returns the parent vcardproperty for the specified vcardvalue.

Since

3.0

Definition at line 1028 of file vcardvalue.c.

vcardvalue_set_parent()

void vcardvalue_set_parent	(	vcardvalue *	value,
		vcardproperty *	property )

Sets the parent vcardproperty for the specified vcardvalue.

Definition at line 1021 of file vcardvalue.c.