The calendar record API provides the set of the definitions and interfaces that enable you to get/set data from/to calendar record handle.

Required Header

#include <calendar.h>

Functions
int	calendar_record_create (const char view_uri, calendar_record_h out_record)
	Creates a record handle.
int	calendar_record_destroy (calendar_record_h record, bool delete_child)
	Destroys a record handle and releases all its resources.
int	calendar_record_clone (calendar_record_h record, calendar_record_h *out_record)
	Makes a clone of a record handle.
int	calendar_record_get_uri_p (calendar_record_h record, char **uri)
	Gets a URI string from a record.
int	calendar_record_get_str (calendar_record_h record, unsigned int property_id, char **out_str)
	Gets a string from a record.
int	calendar_record_get_str_p (calendar_record_h record, unsigned int property_id, char **out_str)
	Gets a string pointer from a record.
int	calendar_record_get_int (calendar_record_h record, unsigned int property_id, int *out_value)
	Gets an integer value from a record.
int	calendar_record_get_double (calendar_record_h record, unsigned int property_id, double *out_value)
	Gets a double value from a record.
int	calendar_record_get_lli (calendar_record_h record, unsigned int property_id, long long int *out_value)
	Gets a long long integer value from a record.
int	calendar_record_get_caltime (calendar_record_h record, unsigned int property_id, calendar_time_s *out_value)
	Gets a calendar_caltime_s value from a record.
int	calendar_record_set_str (calendar_record_h record, unsigned int property_id, const char *value)
	Sets a string to a record.
int	calendar_record_set_int (calendar_record_h record, unsigned int property_id, int value)
	Sets an integer value to a record.
int	calendar_record_set_double (calendar_record_h record, unsigned int property_id, double value)
	Sets a double value to a record.
int	calendar_record_set_lli (calendar_record_h record, unsigned int property_id, long long int value)
	Sets a long long integer value to a record.
int	calendar_record_set_caltime (calendar_record_h record, unsigned int property_id, calendar_time_s value)
	Sets a calendar_time_s value to a record.
int	calendar_record_add_child_record (calendar_record_h record, unsigned int property_id, calendar_record_h child_record)
	Adds a child record to the parent record.
int	calendar_record_remove_child_record (calendar_record_h record, unsigned int property_id, calendar_record_h child_record)
	Removes a child record from the parent record.
int	calendar_record_get_child_record_count (calendar_record_h record, unsigned int property_id, unsigned int *count)
	Gets the number of child records in a record.
int	calendar_record_get_child_record_at_p (calendar_record_h record, unsigned int property_id, int index, calendar_record_h *child_record)
	Gets a child record handle pointer from the parent record.
int	calendar_record_clone_child_record_list (calendar_record_h record, unsigned int property_id, calendar_list_h *out_list)
	Makes a clone of a given record's child record list.

Enumeration Type Documentation

enum calendar_alarm_action_e

Enumeration for the alarm action.

Since :: 3.0

Enumerator:

CALENDAR_ALARM_ACTION_AUDIO	Audio action
CALENDAR_ALARM_ACTION_DISPLAY	Display action
CALENDAR_ALARM_ACTION_EMAIL	Email action
CALENDAR_ALARM_ACTION_MAX	Calendar alarm action max enum count

enum calendar_alarm_time_unit_type_e

Enumeration for the alarm time unit type of an event, such as minutes, hours, days, and so on.

Since :: 3.0

Enumerator:

CALENDAR_ALARM_NONE	No reminder set
CALENDAR_ALARM_TIME_UNIT_SPECIFIC	Specific in seconds
CALENDAR_ALARM_TIME_UNIT_MINUTE	Alarm time unit in minutes
CALENDAR_ALARM_TIME_UNIT_HOUR	Alarm time unit in hours
CALENDAR_ALARM_TIME_UNIT_DAY	Alarm time unit in days
CALENDAR_ALARM_TIME_UNIT_WEEK	Alarm time unit in weeks

enum calendar_attendee_cutyep_e

Enumeration for the attendee cutype.

Since :: 3.0

Enumerator:

CALENDAR_ATTENDEE_CUTYPE_INDIVIDUAL	Individual cutype
CALENDAR_ATTENDEE_CUTYPE_GROUP	Group cutype
CALENDAR_ATTENDEE_CUTYPE_RESOURCE	Resource cutype
CALENDAR_ATTENDEE_CUTYPE_ROOM	Room cutype
CALENDAR_ATTENDEE_CUTYPE_UNKNOWN	Unknown cutype
CALENDAR_ATTENDEE_CUTYPE_MAX	Calendar attendee cutype max enum count

enum calendar_attendee_role_e

Enumeration for the attendee role.

Since :: 3.0

Enumerator:

CALENDAR_ATTENDEE_ROLE_REQ_PARTICIPANT	Participation is required
CALENDAR_ATTENDEE_ROLE_OPT_PARTICIPANT	Accepted status
CALENDAR_ATTENDEE_ROLE_NON_PARTICIPANT	Non-Participant
CALENDAR_ATTENDEE_ROLE_CHAIR	Chairperson
CALENDAR_ATTENDEE_ROLE_MAX	Calendar attendee role max enum count

enum calendar_attendee_status_e

Enumeration for the attendee status.

Since :: 3.0

Enumerator:

CALENDAR_ATTENDEE_STATUS_PENDING	Pending status
CALENDAR_ATTENDEE_STATUS_ACCEPTED	Accepted status
CALENDAR_ATTENDEE_STATUS_DECLINED	Declined status
CALENDAR_ATTENDEE_STATUS_TENTATIVE	Tentative status
CALENDAR_ATTENDEE_STATUS_DELEGATED	Delegated status
CALENDAR_ATTENDEE_STATUS_COMPLETED	Completed status
CALENDAR_ATTENDEE_STATUS_IN_PROCESS	In process status
CALENDAR_ATTENDEE_STATUS_MAX	Calendar attendee status max enum count

enum calendar_book_mode_e

Enumeration for the book mode.

Since :: 3.0

Enumerator:

CALENDAR_BOOK_MODE_NONE	All modules can read and write records of this calendar_book
CALENDAR_BOOK_MODE_RECORD_READONLY	All modules can only read records of this calendar book

enum calendar_book_sync_event_type_e

Enumeration for the sync event type.

Since :: 3.0

Enumerator:

CALENDAR_BOOK_SYNC_EVENT_FOR_ME	This book would not be synced to others except me
CALENDAR_BOOK_SYNC_EVENT_FOR_EVERY_AND_DELETE	This book would be synced to everyone and deleted events would be deleted on time
CALENDAR_BOOK_SYNC_EVENT_FOR_EVERY_AND_REMAIN	This book would be synced to everyone but deleted events would be retained. Deleted events are removed by calendar_db_clean_after_sync() API

enum calendar_book_type_e

Enumeration for the calendar book type.

"OR"ing is supported.

Since :: 3.0

Enumerator:

CALENDAR_BOOK_TYPE_NONE	Default calendar book type
CALENDAR_BOOK_TYPE_EVENT	Event calendar book type
CALENDAR_BOOK_TYPE_TODO	To-do calendar book type

enum calendar_days_of_week_e

Enumeration for weekdays.

Same value as UCalendarDaysOfWeek in ICU.

Since :: 3.0

Enumerator:

CALENDAR_SUNDAY	Sunday
CALENDAR_MONDAY	Monday
CALENDAR_TUESDAY	Tuesday
CALENDAR_WEDNESDAY	Wednesday
CALENDAR_THURSDAY	Thursday
CALENDAR_FRIDAY	Friday
CALENDAR_SATURDAY	Saturday

enum calendar_event_busy_status_e

Enumeration for the busy status of an event.

Since :: 3.0

Enumerator:

CALENDAR_EVENT_BUSY_STATUS_FREE	The free status
CALENDAR_EVENT_BUSY_STATUS_BUSY	The busy status
CALENDAR_EVENT_BUSY_STATUS_UNAVAILABLE	The unavailable status
CALENDAR_EVENT_BUSY_STATUS_TENTATIVE	The tentative status

enum calendar_event_priority_e

Enumeration for the calendar event item's priority.

Since :: 3.0

Enumerator:

CALENDAR_EVENT_PRIORITY_NONE	No priority
CALENDAR_EVENT_PRIORITY_LOW	Low priority
CALENDAR_EVENT_PRIORITY_NORMAL	Normal priority
CALENDAR_EVENT_PRIORITY_HIGH	High priority

enum calendar_event_status_e

Enumeration for the event status.

Since :: 3.0

Enumerator:

CALENDAR_EVENT_STATUS_NONE	No status
CALENDAR_EVENT_STATUS_TENTATIVE	The event is tentative
CALENDAR_EVENT_STATUS_CONFIRMED	The event is confirmed
CALENDAR_EVENT_STATUS_CANCELLED	The event is canceled

enum calendar_meeting_status_e

Enumeration for the meeting status.

Since :: 3.0

Enumerator:

CALENDAR_MEETING_STATUS_NOTMEETING	No meeting
CALENDAR_MEETING_STATUS_MEETING	Meeting exists
CALENDAR_MEETING_STATUS_RECEIVED	Meeting received
CALENDAR_MEETING_STATUS_CANCELED	Meeting canceled

enum calendar_range_type_e

Enumeration for the range type.

Since :: 3.0

Enumerator:

CALENDAR_RANGE_UNTIL	Range until
CALENDAR_RANGE_COUNT	Range count
CALENDAR_RANGE_NONE	No range

enum calendar_record_modified_status_e

Enumeration for the modified status of a record.

Since :: 3.0

Enumerator:

CALENDAR_RECORD_MODIFIED_STATUS_INSERTED	The record is inserted
CALENDAR_RECORD_MODIFIED_STATUS_UPDATED	The record is updated
CALENDAR_RECORD_MODIFIED_STATUS_DELETED	The record is deleted

enum calendar_record_type_e

Enumeration for the type of a record.

Since :: 3.0

Enumerator:

CALENDAR_RECORD_TYPE_NONE	No record type
CALENDAR_RECORD_TYPE_CALENDAR_BOOK	Book type
CALENDAR_RECORD_TYPE_EVENT	Event type
CALENDAR_RECORD_TYPE_TODO	Todo type

enum calendar_recurrence_frequency_e

Enumeration for the frequency of an event's recurrence.

Since :: 3.0

Enumerator:

CALENDAR_RECURRENCE_NONE	No recurrence event
CALENDAR_RECURRENCE_DAILY	An event occurs every day
CALENDAR_RECURRENCE_WEEKLY	An event occurs on the same day of every week. According to the week flag, the event will recur every day of the week
CALENDAR_RECURRENCE_MONTHLY	An event occurs on the same day of every month
CALENDAR_RECURRENCE_YEARLY	An event occurs on the same day of every year

enum calendar_sensitivity_e

Enumeration for the calendar sensitivity type.

Since :: 3.0

Enumerator:

CALENDAR_SENSITIVITY_PUBLIC	Public Sensitivity
CALENDAR_SENSITIVITY_PRIVATE	Private Sensitivity
CALENDAR_SENSITIVITY_CONFIDENTIAL	Confidential Sensitivity

enum calendar_system_type_e

Enumeration for the system type.

Since :: 3.0

Enumerator:

CALENDAR_SYSTEM_NONE	Locale's default calendar
CALENDAR_SYSTEM_GREGORIAN	Locale's default calendar
CALENDAR_SYSTEM_EAST_ASIAN_LUNISOLAR	East asian lunisolar calendar

enum calendar_time_type_e

Enumeration for the time type.

Since :: 3.0

Enumerator:

CALENDAR_TIME_UTIME	Unix time
CALENDAR_TIME_LOCALTIME	Local time

enum calendar_todo_priority_e

Enumeration for the calendar to-do item's priority.

Since :: 3.0

Enumerator:

CALENDAR_TODO_PRIORITY_NONE	No priority
CALENDAR_TODO_PRIORITY_LOW	Low priority
CALENDAR_TODO_PRIORITY_NORMAL	Normal priority
CALENDAR_TODO_PRIORITY_HIGH	High priority

enum calendar_todo_status_e

Enumeration for the status of a to-do.

Since :: 3.0

Enumerator:

CALENDAR_TODO_STATUS_NONE	No status
CALENDAR_TODO_STATUS_NEEDS_ACTION	Needs action status
CALENDAR_TODO_STATUS_COMPLETED	Completed status
CALENDAR_TODO_STATUS_IN_PROCESS	Work in process status
CALENDAR_TODO_STATUS_CANCELED	Canceled status

Function Documentation

int calendar_record_add_child_record	(	calendar_record_h	record,
		unsigned int	property_id,
		calendar_record_h	child_record
	)

Adds a child record to the parent record.

Since :: 3.0

Parameters:

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

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

Return values:

CALENDAR_ERROR_NONE	Successful
CALENDAR_ERROR_INVALID_PARAMETER	Invalid parameter
CALENDAR_ERROR_NOT_PERMITTED	Operation not permitted
CALENDAR_ERROR_SYSTEM	Internal system module error
CALENDAR_ERROR_NOT_SUPPORTED	Not supported

See also:: calendar_record_remove_child_record()

int calendar_record_clone	(	calendar_record_h	record,
		calendar_record_h *	out_record
	)

Makes a clone of a record handle.

Since :: 3.0

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

Parameters:

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

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

Return values:

CALENDAR_ERROR_NONE	Successful
CALENDAR_ERROR_INVALID_PARAMETER	Invalid parameter
CALENDAR_ERROR_NOT_PERMITTED	Operation not permitted
CALENDAR_ERROR_SYSTEM	Internal system module error
CALENDAR_ERROR_NOT_SUPPORTED	Not supported

See also:: calendar_record_destroy()

int calendar_record_clone_child_record_list	(	calendar_record_h	record,
		unsigned int	property_id,
		calendar_list_h *	out_list
	)

Makes a clone of a given record's child record list.

Since :: 3.0

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

Parameters:

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

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

Return values:

CALENDAR_ERROR_NONE	Successful
CALENDAR_ERROR_INVALID_PARAMETER	Invalid parameter
CALENDAR_ERROR_NOT_PERMITTED	Operation not permitted
CALENDAR_ERROR_SYSTEM	Internal system module error
CALENDAR_ERROR_NOT_SUPPORTED	Not supported

See also:: calendar_list_destroy()

int calendar_record_create	(	const char *	view_uri,
		calendar_record_h *	out_record
	)

Creates a record handle.

Since :: 3.0

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

Parameters:

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

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

Return values:

CALENDAR_ERROR_NONE	Successful
CALENDAR_ERROR_OUT_OF_MEMORY	Out of memory
CALENDAR_ERROR_INVALID_PARAMETER	Invalid parameter
CALENDAR_ERROR_NOT_PERMITTED	Operation not permitted
CALENDAR_ERROR_SYSTEM	Internal system module error
CALENDAR_ERROR_NOT_SUPPORTED	Not supported

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

See also:: calendar_record_destroy()

int calendar_record_destroy	(	calendar_record_h	record,
		bool	delete_child
	)

Destroys a record handle and releases all its resources.

Since :: 3.0

Parameters:

[in]	record	The record handle
[in]	delete_child	If `true`, child records are destroyed automatically, otherwise `false`

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

Return values:

CALENDAR_ERROR_NONE	Successful
CALENDAR_ERROR_INVALID_PARAMETER	Invalid parameter
CALENDAR_ERROR_NOT_PERMITTED	Operation not permitted
CALENDAR_ERROR_SYSTEM	Internal system module error
CALENDAR_ERROR_NOT_SUPPORTED	Not supported

See also:: calendar_record_create()

int calendar_record_get_caltime	(	calendar_record_h	record,
		unsigned int	property_id,
		calendar_time_s *	out_value
	)

Gets a calendar_caltime_s value from a record.

Since :: 3.0

Parameters:

[in]	record	The record handle
[in]	property_id	The property ID
[out]	out_value	The result value

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

Return values:

CALENDAR_ERROR_NONE	Successful
CALENDAR_ERROR_INVALID_PARAMETER	Invalid parameter
CALENDAR_ERROR_NOT_PERMITTED	Operation not permitted
CALENDAR_ERROR_SYSTEM	Internal system module error
CALENDAR_ERROR_NOT_SUPPORTED	Not supported

See also:: calendar_record_set_caltime()

int calendar_record_get_child_record_at_p	(	calendar_record_h	record,
		unsigned int	property_id,
		int	index,
		calendar_record_h *	child_record
	)

Gets a child record handle pointer from the parent record.

Since :: 3.0

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

Parameters:

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

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

Return values:

CALENDAR_ERROR_NONE	Successful
CALENDAR_ERROR_INVALID_PARAMETER	Invalid parameter
CALENDAR_ERROR_NOT_PERMITTED	Operation not permitted
CALENDAR_ERROR_SYSTEM	Internal system module error
CALENDAR_ERROR_NOT_SUPPORTED	Not supported

See also:: calendar_record_add_child_record(); calendar_record_remove_child_record(); calendar_record_get_child_record_count()

int calendar_record_get_child_record_count	(	calendar_record_h	record,
		unsigned int	property_id,
		unsigned int *	count
	)

Gets the number of child records in a record.

Since :: 3.0

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:

CALENDAR_ERROR_NONE	Successful
CALENDAR_ERROR_INVALID_PARAMETER	Invalid parameter
CALENDAR_ERROR_NOT_PERMITTED	Operation not permitted
CALENDAR_ERROR_SYSTEM	Internal system module error
CALENDAR_ERROR_NOT_SUPPORTED	Not supported

See also:: calendar_record_add_child_record(); calendar_record_remove_child_record()

int calendar_record_get_double	(	calendar_record_h	record,
		unsigned int	property_id,
		double *	out_value
	)

Gets a double value from a record.

Since :: 3.0

Parameters:

[in]	record	The record handle
[in]	property_id	The property ID
[out]	out_value	The result value

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

Return values:

CALENDAR_ERROR_NONE	Successful
CALENDAR_ERROR_INVALID_PARAMETER	Invalid parameter
CALENDAR_ERROR_NOT_PERMITTED	Operation not permitted
CALENDAR_ERROR_SYSTEM	Internal system module error
CALENDAR_ERROR_NOT_SUPPORTED	Not supported

See also:: calendar_record_set_double()

int calendar_record_get_int	(	calendar_record_h	record,
		unsigned int	property_id,
		int *	out_value
	)

Gets an integer value from a record.

Since :: 3.0

Parameters:

[in]	record	The record handle
[in]	property_id	The property ID
[out]	out_value	The result value

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

Return values:

CALENDAR_ERROR_NONE	Successful
CALENDAR_ERROR_INVALID_PARAMETER	Invalid parameter
CALENDAR_ERROR_NOT_PERMITTED	Operation not permitted
CALENDAR_ERROR_SYSTEM	Internal system module error
CALENDAR_ERROR_NOT_SUPPORTED	Not supported

See also:: calendar_record_set_int()

int calendar_record_get_lli	(	calendar_record_h	record,
		unsigned int	property_id,
		long long int *	out_value
	)

Gets a long long integer value from a record.

Since :: 3.0

Parameters:

[in]	record	The record handle
[in]	property_id	The property ID
[out]	out_value	The result value

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

Return values:

CALENDAR_ERROR_NONE	Successful
CALENDAR_ERROR_INVALID_PARAMETER	Invalid parameter
CALENDAR_ERROR_NOT_PERMITTED	Operation not permitted
CALENDAR_ERROR_SYSTEM	Internal system module error
CALENDAR_ERROR_NOT_SUPPORTED	Not supported

See also:: calendar_record_set_lli()

int calendar_record_get_str	(	calendar_record_h	record,
		unsigned int	property_id,
		char **	out_str
	)

Gets a string from a record.

Since :: 3.0

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

Parameters:

[in]	record	The record handle
[in]	property_id	The property ID
[out]	out_str	The result value

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

Return values:

CALENDAR_ERROR_NONE	Successful
CALENDAR_ERROR_INVALID_PARAMETER	Invalid parameter
CALENDAR_ERROR_NOT_PERMITTED	Operation not permitted
CALENDAR_ERROR_SYSTEM	Internal system module error
CALENDAR_ERROR_NOT_SUPPORTED	Not supported

See also:: calendar_record_get_str_p(); calendar_record_set_str()

int calendar_record_get_str_p	(	calendar_record_h	record,
		unsigned int	property_id,
		char **	out_str
	)

Gets a string pointer from a record.

Since :: 3.0

Remarks:: You MUST NOT release value.

Parameters:

[in]	record	The record handle
[in]	property_id	The property ID
[out]	out_str	The result value

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

Return values:

CALENDAR_ERROR_NONE	Successful
CALENDAR_ERROR_INVALID_PARAMETER	Invalid parameter
CALENDAR_ERROR_NOT_PERMITTED	Operation not permitted
CALENDAR_ERROR_SYSTEM	Internal system module error
CALENDAR_ERROR_NOT_SUPPORTED	Not supported

See also:: calendar_record_get_str(); calendar_record_set_str()

int calendar_record_get_uri_p	(	calendar_record_h	record,
		char **	uri
	)

Gets a URI string from a record.

Since :: 3.0

Parameters:

[in]	record	The record handle
[out]	uri	The URI of the record

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

Return values:

CALENDAR_ERROR_NONE	Successful
CALENDAR_ERROR_INVALID_PARAMETER	Invalid parameter
CALENDAR_ERROR_SYSTEM	Internal system module error
CALENDAR_ERROR_NOT_SUPPORTED	Not supported

int calendar_record_remove_child_record	(	calendar_record_h	record,
		unsigned int	property_id,
		calendar_record_h	child_record
	)

Removes a child record from the parent record.

Since :: 3.0

Parameters:

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

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

Return values:

CALENDAR_ERROR_NONE	Successful
CALENDAR_ERROR_INVALID_PARAMETER	Invalid parameter
CALENDAR_ERROR_NOT_PERMITTED	Operation not permitted
CALENDAR_ERROR_SYSTEM	Internal system module error
CALENDAR_ERROR_NOT_SUPPORTED	Not supported

See also:: calendar_record_add_child_record()

int calendar_record_set_caltime	(	calendar_record_h	record,
		unsigned int	property_id,
		calendar_time_s	value
	)

Sets a calendar_time_s value to a record.

Since :: 3.0

Parameters:

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

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

Return values:

CALENDAR_ERROR_NONE	Successful
CALENDAR_ERROR_INVALID_PARAMETER	Invalid parameter
CALENDAR_ERROR_NOT_PERMITTED	Operation not permitted
CALENDAR_ERROR_SYSTEM	Internal system module error
CALENDAR_ERROR_NOT_SUPPORTED	Not supported

See also:: calendar_record_get_caltime()

int calendar_record_set_double	(	calendar_record_h	record,
		unsigned int	property_id,
		double	value
	)

Sets a double value to a record.

Since :: 3.0

Parameters:

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

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

Return values:

CALENDAR_ERROR_NONE	Successful
CALENDAR_ERROR_INVALID_PARAMETER	Invalid parameter
CALENDAR_ERROR_NOT_PERMITTED	Operation not permitted
CALENDAR_ERROR_SYSTEM	Internal system module error
CALENDAR_ERROR_NOT_SUPPORTED	Not supported

See also:: calendar_record_get_double()

int calendar_record_set_int	(	calendar_record_h	record,
		unsigned int	property_id,
		int	value
	)

Sets an integer value to a record.

Since :: 3.0

Parameters:

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

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

Return values:

CALENDAR_ERROR_NONE	Successful
CALENDAR_ERROR_INVALID_PARAMETER	Invalid parameter
CALENDAR_ERROR_NOT_PERMITTED	Operation not permitted
CALENDAR_ERROR_SYSTEM	Internal system module error
CALENDAR_ERROR_NOT_SUPPORTED	Not supported

See also:: calendar_record_get_int()

int calendar_record_set_lli	(	calendar_record_h	record,
		unsigned int	property_id,
		long long int	value
	)

Sets a long long integer value to a record.

Since :: 3.0

Parameters:

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

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

Return values:

CALENDAR_ERROR_NONE	Successful
CALENDAR_ERROR_INVALID_PARAMETER	Invalid parameter
CALENDAR_ERROR_NOT_PERMITTED	Operation not permitted
CALENDAR_ERROR_SYSTEM	Internal system module error
CALENDAR_ERROR_NOT_SUPPORTED	Not supported

See also:: calendar_record_get_lli()

int calendar_record_set_str	(	calendar_record_h	record,
		unsigned int	property_id,
		const char *	value
	)

Sets a string to a record.

Since :: 3.0

Parameters:

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

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

Return values:

CALENDAR_ERROR_NONE	Successful
CALENDAR_ERROR_INVALID_PARAMETER	Invalid parameter
CALENDAR_ERROR_NOT_PERMITTED	Operation not permitted
CALENDAR_ERROR_SYSTEM	Internal system module error
CALENDAR_ERROR_NOT_SUPPORTED	Not supported

See also:: calendar_record_get_str(); calendar_record_get_str_p()

Required Header

Functions

Enumeration Type Documentation

Function Documentation