The contacts record API provides the set of the definitions and interfaces that enable application developers to get/set data from/to contacts record handle.

Required Header

#include <contacts.h>

Functions
int	contacts_record_create (const char view_uri, contacts_record_h record)
	Creates a record.
int	contacts_record_destroy (contacts_record_h record, bool delete_child)
	Destroys a record and releases its all resources.
int	contacts_record_clone (contacts_record_h record, contacts_record_h *cloned_record)
	Makes a clone of a record.
int	contacts_record_get_str (contacts_record_h record, unsigned int property_id, char **value)
	Gets a string from the record handle.
int	contacts_record_get_str_p (contacts_record_h record, unsigned int property_id, char **value)
	Gets a string pointer from the record handle.
int	contacts_record_set_str (contacts_record_h record, unsigned int property_id, const char *value)
	Sets a string to a record.
int	contacts_record_get_int (contacts_record_h record, unsigned int property_id, int *value)
	Gets a record's integer value.
int	contacts_record_set_int (contacts_record_h record, unsigned int property_id, int value)
	Sets an integer value to a record.
int	contacts_record_get_lli (contacts_record_h record, unsigned int property_id, long long int *value)
	Gets a record's long integer value.
int	contacts_record_set_lli (contacts_record_h record, unsigned int property_id, long long int value)
	Sets a long long integer value to a record.
int	contacts_record_get_bool (contacts_record_h record, unsigned int property_id, bool *value)
	Gets a record's boolean value.
int	contacts_record_set_bool (contacts_record_h record, unsigned int property_id, bool value)
	Sets a boolean value to a record.
int	contacts_record_get_double (contacts_record_h record, unsigned int property_id, double *value)
	Gets a record's double value.
int	contacts_record_set_double (contacts_record_h record, unsigned int property_id, double value)
	Sets a double value to a record.
int	contacts_record_add_child_record (contacts_record_h record, unsigned int property_id, contacts_record_h child_record)
	Adds a child record to the parent record.
int	contacts_record_remove_child_record (contacts_record_h record, unsigned int property_id, contacts_record_h child_record)
	Removes a child record from the parent record.
int	contacts_record_get_child_record_count (contacts_record_h record, unsigned int property_id, int *count)
	Gets the number of child records of a parent record.
int	contacts_record_get_child_record_at_p (contacts_record_h record, unsigned int property_id, int index, contacts_record_h *child_record)
	Gets a child record handle pointer from the parent record.
int	contacts_record_clone_child_record_list (contacts_record_h record, unsigned int property_id, contacts_list_h *cloned_list)
	Clones a child record list of the given parent record.
int	contacts_record_get_uri_p (contacts_record_h record, const char **view_uri)
	Gets URI string from a record.
Typedefs
typedef struct __contacts_record_h *	contacts_record_h
	Handle for contacts record.
typedef struct __contacts_filter_h *	contacts_filter_h
	Handle for contacts filter.
typedef struct __contacts_list_h *	contacts_list_h
	Handle for contacts list.
typedef struct __contacts_query_h *	contacts_query_h
	Handle for contacts query.
typedef struct __contacts_h *	contacts_h
	The contacts handle.

Typedef Documentation

typedef struct __contacts_filter_h * contacts_filter_h

Handle for contacts filter.

Since :: 2.3

typedef struct __contacts_h * contacts_h

The contacts handle.

Since :: 2.3

typedef struct __contacts_list_h * contacts_list_h

Handle for contacts list.

Since :: 2.3

typedef struct __contacts_query_h * contacts_query_h

Handle for contacts query.

Since :: 2.3

typedef struct __contacts_record_h * contacts_record_h

Handle for contacts record.

Since :: 2.3

Enumeration Type Documentation

enum contacts_address_book_mode_e

Enumeration for Address book mode.

Since :: 2.3

Enumerator:

CONTACTS_ADDRESS_BOOK_MODE_NONE	All module can read and write contacts of this address_book
CONTACTS_ADDRESS_BOOK_MODE_READONLY	All module can only read contacts of this address_book

enum contacts_address_type_e

Enumeration for Contact address type.

Since :: 2.3

Enumerator:

CONTACTS_ADDRESS_TYPE_OTHER	Other address type
CONTACTS_ADDRESS_TYPE_CUSTOM	A delivery address for a residence
CONTACTS_ADDRESS_TYPE_HOME	A delivery address for a residence
CONTACTS_ADDRESS_TYPE_WORK	A delivery address for a place of work
CONTACTS_ADDRESS_TYPE_DOM	A domestic delivery address
CONTACTS_ADDRESS_TYPE_INTL	An international delivery address
CONTACTS_ADDRESS_TYPE_POSTAL	A postal delivery address
CONTACTS_ADDRESS_TYPE_PARCEL	A parcel delivery address

enum contacts_company_type_e

Enumeration for Contact company type.

Since :: 2.3

Enumerator:

CONTACTS_COMPANY_TYPE_OTHER	Other company type
CONTACTS_COMPANY_TYPE_CUSTOM	Custom company type
CONTACTS_COMPANY_TYPE_WORK	Work company type

enum contacts_contact_link_mode_e

Enumeration for link mode when inserting contact.

Since :: 2.3

Enumerator:

CONTACTS_CONTACT_LINK_MODE_NONE	Auto link immediately
CONTACTS_CONTACT_LINK_MODE_IGNORE_ONCE	Do not auto link when the contact is inserted

enum contacts_data_type_e

Enumeration for contacts data type.

Since :: 3.0

enum contacts_display_name_source_type_e

Enumeration for Contact display name source type.

Since :: 2.3

Enumerator:

CONTACTS_DISPLAY_NAME_SOURCE_TYPE_INVALID	Invalid source of display name
CONTACTS_DISPLAY_NAME_SOURCE_TYPE_EMAIL	Produced display name from email record
CONTACTS_DISPLAY_NAME_SOURCE_TYPE_NUMBER	Produced display name from number record
CONTACTS_DISPLAY_NAME_SOURCE_TYPE_NICKNAME	Produced display name from nickname record
CONTACTS_DISPLAY_NAME_SOURCE_TYPE_COMPANY	Produced display name from company record
CONTACTS_DISPLAY_NAME_SOURCE_TYPE_NAME	Produced display name from name record

enum contacts_email_type_e

Enumeration for Contact email type.

Since :: 2.3

Enumerator:

CONTACTS_EMAIL_TYPE_OTHER	Other email type
CONTACTS_EMAIL_TYPE_CUSTOM	Custom email type
CONTACTS_EMAIL_TYPE_HOME	An email address associated with a residence
CONTACTS_EMAIL_TYPE_WORK	An email address associated with a place of work
CONTACTS_EMAIL_TYPE_MOBILE	A mobile email address

enum contacts_event_calendar_type_e

Enumeration for Contact event calendar type.

Since :: 2.3

Enumerator:

CONTACTS_EVENT_CALENDAR_TYPE_GREGORIAN	Gregorian calendar
CONTACTS_EVENT_CALENDAR_TYPE_CHINESE	Chinese calendar

enum contacts_event_type_e

Enumeration for Contact event type.

Since :: 2.3

Enumerator:

CONTACTS_EVENT_TYPE_OTHER	Other event type
CONTACTS_EVENT_TYPE_CUSTOM	Custom event type
CONTACTS_EVENT_TYPE_BIRTH	Birthday event type
CONTACTS_EVENT_TYPE_ANNIVERSARY	Anniversary event type

enum contacts_image_type_e

Enumeration for Contact image type.

Since :: 2.3

Enumerator:

CONTACTS_IMAGE_TYPE_OTHER	Other type
CONTACTS_IMAGE_TYPE_CUSTOM	Custom type

enum contacts_messenger_type_e

Enumeration for Contact messenger type.

Since :: 2.3

Enumerator:

CONTACTS_MESSENGER_TYPE_OTHER	Other messenger type
CONTACTS_MESSENGER_TYPE_CUSTOM	Custom messenger type
CONTACTS_MESSENGER_TYPE_GOOGLE	Google messenger type
CONTACTS_MESSENGER_TYPE_WLM	Windows live messenger type
CONTACTS_MESSENGER_TYPE_YAHOO	Yahoo messenger type
CONTACTS_MESSENGER_TYPE_FACEBOOK	Facebook messenger type
CONTACTS_MESSENGER_TYPE_ICQ	ICQ type
CONTACTS_MESSENGER_TYPE_AIM	AOL instance messenger type
CONTACTS_MESSENGER_TYPE_QQ	QQ type
CONTACTS_MESSENGER_TYPE_JABBER	Jabber type
CONTACTS_MESSENGER_TYPE_SKYPE	Skype type
CONTACTS_MESSENGER_TYPE_IRC	IRC type

enum contacts_number_type_e

Enumeration for contacts number type.

The number can be made with a set of values by specifying one or more values. Example : CTS_NUM_TYPE_HOME|CTS_NUM_TYPE_VOICE Exceptionally, CTS_NUM_TYPE_CUSTOM is exclusive.

Since :: 2.3

Enumerator:

CONTACTS_NUMBER_TYPE_OTHER	Other number type
CONTACTS_NUMBER_TYPE_CUSTOM	Custom number type
CONTACTS_NUMBER_TYPE_HOME	A telephone number associated with a residence
CONTACTS_NUMBER_TYPE_WORK	A telephone number associated with a place of work
CONTACTS_NUMBER_TYPE_VOICE	A voice telephone number
CONTACTS_NUMBER_TYPE_FAX	A facsimile telephone number
CONTACTS_NUMBER_TYPE_MSG	The telephone number has voice messaging support
CONTACTS_NUMBER_TYPE_CELL	A cellular telephone number
CONTACTS_NUMBER_TYPE_PAGER	A paging device telephone number
CONTACTS_NUMBER_TYPE_BBS	A bulletin board system telephone number
CONTACTS_NUMBER_TYPE_MODEM	A MODEM connected telephone number
CONTACTS_NUMBER_TYPE_CAR	A car-phone telephone number
CONTACTS_NUMBER_TYPE_ISDN	An ISDN service telephone number
CONTACTS_NUMBER_TYPE_VIDEO	A video conferencing telephone number
CONTACTS_NUMBER_TYPE_PCS	A personal communication services telephone number
CONTACTS_NUMBER_TYPE_COMPANY_MAIN	A company main number
CONTACTS_NUMBER_TYPE_RADIO	A radio phone number
CONTACTS_NUMBER_TYPE_MAIN	An additional type for main
CONTACTS_NUMBER_TYPE_ASSISTANT	An additional type for assistant

enum contacts_phone_log_type_e

Enumeration for Call history type.

Since :: 2.3

Enumerator:

CONTACTS_PLOG_TYPE_NONE	None
CONTACTS_PLOG_TYPE_VOICE_INCOMING	Incoming call
CONTACTS_PLOG_TYPE_VOICE_OUTGOING	Outgoing call
CONTACTS_PLOG_TYPE_VIDEO_INCOMING	Incoming video call
CONTACTS_PLOG_TYPE_VIDEO_OUTGOING	Outgoing video call
CONTACTS_PLOG_TYPE_VOICE_INCOMING_UNSEEN	Not confirmed missed call
CONTACTS_PLOG_TYPE_VOICE_INCOMING_SEEN	Confirmed missed call
CONTACTS_PLOG_TYPE_VIDEO_INCOMING_UNSEEN	Not confirmed missed video call
CONTACTS_PLOG_TYPE_VIDEO_INCOMING_SEEN	Confirmed missed video call
CONTACTS_PLOG_TYPE_VOICE_REJECT	Rejected call
CONTACTS_PLOG_TYPE_VIDEO_REJECT	Rejected video call
CONTACTS_PLOG_TYPE_VOICE_BLOCKED	Blocked call
CONTACTS_PLOG_TYPE_VIDEO_BLOCKED	Blocked video call
CONTACTS_PLOG_TYPE_MMS_INCOMING	Incoming MMS
CONTACTS_PLOG_TYPE_MMS_OUTGOING	Outgoing MMS
CONTACTS_PLOG_TYPE_SMS_INCOMING	Incoming SMS
CONTACTS_PLOG_TYPE_SMS_OUTGOING	Outgoing SMS
CONTACTS_PLOG_TYPE_SMS_BLOCKED	Blocked SMS
CONTACTS_PLOG_TYPE_MMS_BLOCKED	Blocked MMS
CONTACTS_PLOG_TYPE_EMAIL_RECEIVED	Received email
CONTACTS_PLOG_TYPE_EMAIL_SENT	Sent email

enum contacts_relationship_type_e

Enumeration for Contact relationship type.

Since :: 2.3

Enumerator:

CONTACTS_RELATIONSHIP_TYPE_OTHER	Other relationship type
CONTACTS_RELATIONSHIP_TYPE_ASSISTANT	Assistant type
CONTACTS_RELATIONSHIP_TYPE_BROTHER	Brother type
CONTACTS_RELATIONSHIP_TYPE_CHILD	Child type
CONTACTS_RELATIONSHIP_TYPE_DOMESTIC_PARTNER	Domestic Partner type
CONTACTS_RELATIONSHIP_TYPE_FATHER	Father type
CONTACTS_RELATIONSHIP_TYPE_FRIEND	Friend type
CONTACTS_RELATIONSHIP_TYPE_MANAGER	Manager type
CONTACTS_RELATIONSHIP_TYPE_MOTHER	Mother type
CONTACTS_RELATIONSHIP_TYPE_PARENT	Parent type
CONTACTS_RELATIONSHIP_TYPE_PARTNER	Partner type
CONTACTS_RELATIONSHIP_TYPE_REFERRED_BY	Referred by type
CONTACTS_RELATIONSHIP_TYPE_RELATIVE	Relative type
CONTACTS_RELATIONSHIP_TYPE_SISTER	Sister type
CONTACTS_RELATIONSHIP_TYPE_SPOUSE	Spouse type
CONTACTS_RELATIONSHIP_TYPE_CUSTOM	Custom type

enum contacts_search_range_e

Enumeration for Contact search range.

Since :: 2.3

Enumerator:

CONTACTS_SEARCH_RANGE_NAME	Search record from name
CONTACTS_SEARCH_RANGE_NUMBER	Search record from name and number
CONTACTS_SEARCH_RANGE_DATA	Search record from name,number and data
CONTACTS_SEARCH_RANGE_EMAIL	Search record from name,number,data and email. Now, support only _contacts_person_email view_uri

enum contacts_sip_type_e

Enumeration for SIP(Session Initiation Protocol) type range.

Since :: 3.0

Enumerator:

CONTACTS_SIP_TYPE_OTHER	Other sip type
CONTACTS_SIP_TYPE_CUSTOM	Custom sip type
CONTACTS_SIP_TYPE_HOME	Home sip type
CONTACTS_SIP_TYPE_WORK	Work sip type

enum contacts_url_type_e

Enumeration for Contact URL type.

Since :: 2.3

Enumerator:

CONTACTS_URL_TYPE_OTHER	Other URL type
CONTACTS_URL_TYPE_CUSTOM	Custom URL type
CONTACTS_URL_TYPE_HOME	Home URL type
CONTACTS_URL_TYPE_WORK	Work URL type

enum contacts_usage_type_e

Enumeration for usage type.

Since :: 2.3

Enumerator:

CONTACTS_USAGE_STAT_TYPE_NONE	None
CONTACTS_USAGE_STAT_TYPE_OUTGOING_CALL	Outgoing call
CONTACTS_USAGE_STAT_TYPE_OUTGOING_MSG	Outgoing message
CONTACTS_USAGE_STAT_TYPE_OUTGOING_EMAIL	Outgoing email (Since 3.0)
CONTACTS_USAGE_STAT_TYPE_INCOMING_CALL	Incoming call (Since 3.0)
CONTACTS_USAGE_STAT_TYPE_INCOMING_MSG	Incoming message (Since 3.0)
CONTACTS_USAGE_STAT_TYPE_INCOMING_EMAIL	Incoming email (Since 3.0)
CONTACTS_USAGE_STAT_TYPE_MISSED_CALL	Missed call (Since 3.0)
CONTACTS_USAGE_STAT_TYPE_REJECTED_CALL	Rejected call (Since 3.0)
CONTACTS_USAGE_STAT_TYPE_BLOCKED_CALL	Blocked call (Since 3.0)
CONTACTS_USAGE_STAT_TYPE_BLOCKED_MSG	Blocked message (Since 3.0)

Function Documentation

int contacts_record_add_child_record	(	contacts_record_h	record,
		unsigned int	property_id,
		contacts_record_h	child_record
	)

Adds a child record to the parent record.

Since :: 2.3

Parameters:

[in]	record	The parent record handle
[in]	property_id	The property ID
[in]	child_record	The child record handle to be added to parent record handle

Returns:: 0 on success, otherwise a negative error value

Return values:

CONTACTS_ERROR_NONE	Successful
CONTACTS_ERROR_INVALID_PARAMETER	Invalid parameter
CONTACTS_ERROR_NOT_SUPPORTED	Not supported
CONTACTS_ERROR_SYSTEM	Internal system module error

See also:: contacts_record_remove_child_record()

int contacts_record_clone	(	contacts_record_h	record,
		contacts_record_h *	cloned_record
	)

Makes a clone of a record.

Since :: 2.3

Remarks:: You must release cloned_record using contacts_record_destroy().

Parameters:

[in]	record	The record handle
[out]	cloned_record	The cloned record handle

Returns:: 0 on success, otherwise a negative error value

Return values:

CONTACTS_ERROR_NONE	Successful
CONTACTS_ERROR_OUT_OF_MEMORY	Out of memory
CONTACTS_ERROR_INVALID_PARAMETER	Invalid parameter
CONTACTS_ERROR_NOT_SUPPORTED	Not supported
CONTACTS_ERROR_SYSTEM	Internal system module error

See also:: contacts_record_destroy()

int contacts_record_clone_child_record_list	(	contacts_record_h	record,
		unsigned int	property_id,
		contacts_list_h *	cloned_list
	)

Clones a child record list of the given parent record.

Since :: 2.3

Remarks:: You must release cloned_list using contacts_list_destroy().

Parameters:

[in]	record	The record handle
[in]	property_id	The property ID
[out]	cloned_list	The cloned list handle

Returns:: 0 on success, otherwise a negative error value

Return values:

CONTACTS_ERROR_NONE	Successful
CONTACTS_ERROR_INVALID_PARAMETER	Invalid parameter
CONTACTS_ERROR_NOT_SUPPORTED	Not supported
CONTACTS_ERROR_SYSTEM	Internal system module error

See also:: contacts_list_destroy()

int contacts_record_create	(	const char *	view_uri,
		contacts_record_h *	record
	)

Creates a record.

Since :: 2.3

Remarks:: You must release record using contacts_record_destroy().

Parameters:

[in]	view_uri	The view URI
[out]	record	The record handle

Returns:: 0 on success, otherwise a negative error value

Return values:

CONTACTS_ERROR_NONE	Successful
CONTACTS_ERROR_OUT_OF_MEMORY	Out of memory
CONTACTS_ERROR_INVALID_PARAMETER	Invalid parameter
CONTACTS_ERROR_NOT_SUPPORTED	Not supported
CONTACTS_ERROR_SYSTEM	Internal system module error

Precondition:: contacts_connect() should be called to initialize.

See also:: contacts_record_destroy()

int contacts_record_destroy	(	contacts_record_h	record,
		bool	delete_child
	)

Destroys a record and releases its all resources.

Since :: 2.3

Parameters:

[in]	record	The record handle
[in]	delete_child	Set `true` to destroy child records automatically, otherwise set `false` to not destroy child records automatically

Returns:: 0 on success, otherwise a negative error value

Return values:

CONTACTS_ERROR_NONE	Successful
CONTACTS_ERROR_INVALID_PARAMETER	Invalid parameter
CONTACTS_ERROR_NOT_SUPPORTED	Not supported
CONTACTS_ERROR_SYSTEM	Internal system module error

See also:: contacts_record_create()

int contacts_record_get_bool	(	contacts_record_h	record,
		unsigned int	property_id,
		bool *	value
	)

Gets a record's boolean value.

Since :: 2.3

Parameters:

[in]	record	The record handle
[in]	property_id	The property ID
[out]	value	The value to be returned

Returns:: 0 on success, otherwise a negative error value

Return values:

CONTACTS_ERROR_NONE	Successful
CONTACTS_ERROR_INVALID_PARAMETER	Invalid parameter
CONTACTS_ERROR_NOT_SUPPORTED	Not supported
CONTACTS_ERROR_SYSTEM	Internal system module error

See also:: contacts_record_set_bool()

int contacts_record_get_child_record_at_p	(	contacts_record_h	record,
		unsigned int	property_id,
		int	index,
		contacts_record_h *	child_record
	)

Gets a child record handle pointer from the parent record.

Since :: 2.3

Remarks:: You MUST NOT release child_record. It is released when the parent record is destroyed.

Parameters:

[in]	record	The record handle
[in]	property_id	The property ID
[in]	index	The index of child record
[out]	child_record	The child record handle pointer

Returns:: 0 on success, otherwise a negative error value

Return values:

CONTACTS_ERROR_NONE	Successful
CONTACTS_ERROR_INVALID_PARAMETER	Invalid parameter
CONTACTS_ERROR_NO_DATA
CONTACTS_ERROR_NOT_SUPPORTED	Not supported
CONTACTS_ERROR_SYSTEM	Internal system module error

See also:: contacts_record_add_child_record(); contacts_record_remove_child_record(); contacts_record_get_child_record_count()

int contacts_record_get_child_record_count	(	contacts_record_h	record,
		unsigned int	property_id,
		int *	count
	)

Gets the number of child records of a parent record.

Since :: 2.3

Parameters:

[in]	record	The parent record handle
[in]	property_id	The property ID
[out]	count	The child record count

Returns:: 0 on success, otherwise a negative error value

Return values:

CONTACTS_ERROR_NONE	Successful
CONTACTS_ERROR_INVALID_PARAMETER	Invalid parameter
CONTACTS_ERROR_NOT_SUPPORTED	Not supported
CONTACTS_ERROR_SYSTEM	Internal system module error

See also:: contacts_record_add_child_record(); contacts_record_remove_child_record()

int contacts_record_get_double	(	contacts_record_h	record,
		unsigned int	property_id,
		double *	value
	)

Gets a record's double value.

Since :: 2.3

Parameters:

[in]	record	The record handle
[in]	property_id	The property ID
[out]	value	The value to be returned

Returns:: 0 on success, otherwise a negative error value

Return values:

CONTACTS_ERROR_NONE	Successful
CONTACTS_ERROR_INVALID_PARAMETER	Invalid parameter
CONTACTS_ERROR_NOT_SUPPORTED	Not supported
CONTACTS_ERROR_SYSTEM	Internal system module error

See also:: contacts_record_set_double()

int contacts_record_get_int	(	contacts_record_h	record,
		unsigned int	property_id,
		int *	value
	)

Gets a record's integer value.

Since :: 2.3

Parameters:

[in]	record	The record handle
[in]	property_id	The property ID
[out]	value	The value to be returned

Returns:: 0 on success, otherwise a negative error value

Return values:

CONTACTS_ERROR_NONE	Successful
CONTACTS_ERROR_INVALID_PARAMETER	Invalid parameter
CONTACTS_ERROR_NOT_SUPPORTED	Not supported
CONTACTS_ERROR_SYSTEM	Internal system module error

See also:: contacts_record_set_int()

int contacts_record_get_lli	(	contacts_record_h	record,
		unsigned int	property_id,
		long long int *	value
	)

Gets a record's long integer value.

Since :: 2.3

Parameters:

[in]	record	The record handle
[in]	property_id	The property ID
[out]	value	The value to be returned

Returns:: 0 on success, otherwise a negative error value

Return values:

CONTACTS_ERROR_NONE	Successful
CONTACTS_ERROR_INVALID_PARAMETER	Invalid parameter
CONTACTS_ERROR_NOT_SUPPORTED	Not supported
CONTACTS_ERROR_SYSTEM	Internal system module error

See also:: contacts_record_set_lli()

int contacts_record_get_str	(	contacts_record_h	record,
		unsigned int	property_id,
		char **	value
	)

Gets a string from the record handle.

Since :: 2.3

Remarks:: You must release value using free().

Parameters:

[in]	record	The record handle
[in]	property_id	The property ID
[out]	value	The value to be returned

Returns:: 0 on success, otherwise a negative error value

Return values:

CONTACTS_ERROR_NONE	Successful
CONTACTS_ERROR_INVALID_PARAMETER	Invalid parameter
CONTACTS_ERROR_NOT_SUPPORTED	Not supported
CONTACTS_ERROR_SYSTEM	Internal system module error

See also:: contacts_record_get_str_p(); contacts_record_set_str()

int contacts_record_get_str_p	(	contacts_record_h	record,
		unsigned int	property_id,
		char **	value
	)

Gets a string pointer from the record handle.

Since :: 2.3

Remarks:: You MUST NOT release value.

Parameters:

[in]	record	The record handle
[in]	property_id	The property ID
[out]	value	The value to be returned

Returns:: 0 on success, otherwise a negative error value

Return values:

CONTACTS_ERROR_NONE	Successful
CONTACTS_ERROR_INVALID_PARAMETER	Invalid parameter
CONTACTS_ERROR_NOT_SUPPORTED	Not supported
CONTACTS_ERROR_SYSTEM	Internal system module error

See also:: contacts_record_get_str(); contacts_record_set_str()

int contacts_record_get_uri_p	(	contacts_record_h	record,
		const char **	view_uri
	)

Gets URI string from a record.

Since :: 2.3

Parameters:

[in]	record	The record handle
[out]	view_uri	The URI of record

Returns:: 0 on success, otherwise a negative error value

Return values:

CONTACTS_ERROR_NONE	Successful
CONTACTS_ERROR_INVALID_PARAMETER	Invalid parameter
CONTACTS_ERROR_NOT_SUPPORTED	Not supported
CONTACTS_ERROR_SYSTEM	Internal system module error

int contacts_record_remove_child_record	(	contacts_record_h	record,
		unsigned int	property_id,
		contacts_record_h	child_record
	)

Removes a child record from the parent record.

Since :: 2.3

Parameters:

[in]	record	The parent record handle
[in]	property_id	The property ID
[in]	child_record	The child record handle to be removed from parent record handle

Returns:: 0 on success, otherwise a negative error value

Return values:

CONTACTS_ERROR_NONE	Successful
CONTACTS_ERROR_INVALID_PARAMETER	Invalid parameter
CONTACTS_ERROR_NOT_SUPPORTED	Not supported
CONTACTS_ERROR_SYSTEM	Internal system module error

See also:: contacts_record_add_child_record()

int contacts_record_set_bool	(	contacts_record_h	record,
		unsigned int	property_id,
		bool	value
	)

Sets a boolean value to a record.

Since :: 2.3

Parameters:

[in]	record	The record handle
[in]	property_id	The property ID
[in]	value	The value to set

Returns:: 0 on success, otherwise a negative error value

Return values:

CONTACTS_ERROR_NONE	Successful
CONTACTS_ERROR_INVALID_PARAMETER	Invalid parameter
CONTACTS_ERROR_NOT_SUPPORTED	Not supported
CONTACTS_ERROR_SYSTEM	Internal system module error

See also:: contacts_record_get_bool()

int contacts_record_set_double	(	contacts_record_h	record,
		unsigned int	property_id,
		double	value
	)

Sets a double value to a record.

Since :: 2.3

Parameters:

[in]	record	The record handle
[in]	property_id	The property ID
[in]	value	The value to set

Returns:: 0 on success, otherwise a negative error value

Return values:

CONTACTS_ERROR_NONE	Successful
CONTACTS_ERROR_INVALID_PARAMETER	Invalid parameter
CONTACTS_ERROR_NOT_SUPPORTED	Not supported
CONTACTS_ERROR_SYSTEM	Internal system module error

See also:: contacts_record_get_double()

int contacts_record_set_int	(	contacts_record_h	record,
		unsigned int	property_id,
		int	value
	)

Sets an integer value to a record.

Since :: 2.3

Parameters:

[in]	record	The record handle
[in]	property_id	The property ID
[in]	value	The value to set

Returns:: 0 on success, otherwise a negative error value

Return values:

CONTACTS_ERROR_NONE	Successful
CONTACTS_ERROR_INVALID_PARAMETER	Invalid parameter
CONTACTS_ERROR_NOT_SUPPORTED	Not supported
CONTACTS_ERROR_SYSTEM	Internal system module error

See also:: contacts_record_get_int()

int contacts_record_set_lli	(	contacts_record_h	record,
		unsigned int	property_id,
		long long int	value
	)

Sets a long long integer value to a record.

Since :: 2.3

Parameters:

[in]	record	The record handle
[in]	property_id	The property ID
[in]	value	The value to set

Returns:: 0 on success, otherwise a negative error value

Return values:

CONTACTS_ERROR_NONE	Successful
CONTACTS_ERROR_INVALID_PARAMETER	Invalid parameter
CONTACTS_ERROR_NOT_SUPPORTED	Not supported
CONTACTS_ERROR_SYSTEM	Internal system module error

See also:: contacts_record_get_lli()

int contacts_record_set_str	(	contacts_record_h	record,
		unsigned int	property_id,
		const char *	value
	)

Sets a string to a record.

Since :: 2.3

Parameters:

[in]	record	The record handle
[in]	property_id	The property ID
[in]	value	The value to set

Returns:: 0 on success, otherwise a negative error value

Return values:

CONTACTS_ERROR_NONE	Successful
CONTACTS_ERROR_INVALID_PARAMETER	Invalid parameter
CONTACTS_ERROR_NOT_SUPPORTED	Not supported
CONTACTS_ERROR_SYSTEM	Internal system module error

See also:: contacts_record_get_str(); contacts_record_get_str_p()

Required Header

Functions

Typedefs

Typedef Documentation

Enumeration Type Documentation

Function Documentation