Date Interval

---

Date Interval represents a date interval.

Required Header

#include <utils_i18n.h>

Overview

The module represents a date interval.

Functions
int	i18n_date_interval_create (i18n_udate from_date, i18n_udate to_date, i18n_date_interval_h *date_interval)
	Creates a date interval object.
int	i18n_date_interval_destroy (i18n_date_interval_h date_interval)
	Destroys the date interval object.
int	i18n_date_interval_clone (i18n_date_interval_h date_interval, i18n_date_interval_h *clone)
	Clones the date interval object.
int	i18n_date_interval_get_from_date (i18n_date_interval_h date_interval, i18n_udate *from_date)
	Gets the 'from date' from a given date interval object.
int	i18n_date_interval_get_to_date (i18n_date_interval_h date_interval, i18n_udate *to_date)
	Gets the 'to date' from a given date interval object.
int	i18n_date_interval_equals (i18n_date_interval_h date_interval_1, i18n_date_interval_h date_interval_2, i18n_ubool *equals)
	Compares two date interval objects.
Typedefs
typedef void *	i18n_date_interval_h
	An i18n_date_interval_h handle.

---

Typedef Documentation

typedef void* i18n_date_interval_h

An i18n_date_interval_h handle.

Use i18n_date_interval_* functions to operate on i18n_date_interval_h objects.

Since :

5.0

---

Function Documentation

int i18n_date_interval_clone	(	i18n_date_interval_h	date_interval,
		i18n_date_interval_h *	clone
	)

Clones the date interval object.

Since :

5.0

Remarks:

The cloned object should be released by the caller with the i18n_date_interval_destroy() function.

Parameters:

[in]	date_interval	The date interval to be cloned
[out]	clone	The clone of the given date_interval object

Returns:

0 on success, otherwise a negative error value

Return values:

I18N_ERROR_NONE	Successful
I18N_ERROR_INVALID_PARAMETER	Invalid function parameter
I18N_ERROR_OUT_OF_MEMORY	Out of memory

int i18n_date_interval_create	(	i18n_udate	from_date,
		i18n_udate	to_date,
		i18n_date_interval_h *	date_interval
	)

Creates a date interval object.

Since :

5.0

Remarks:

The created object should be released by the caller with the i18n_date_interval_destroy() function.

Parameters:

[in]	from_date	The start date of the date interval
[in]	to_date	The end date of the date interval
[out]	date_interval	The created date interval object

Returns:

0 on success, otherwise a negative error value

Return values:

I18N_ERROR_NONE	Successful
I18N_ERROR_INVALID_PARAMETER	Invalid function parameter
I18N_ERROR_OUT_OF_MEMORY	Out of memory

int i18n_date_interval_destroy

(

i18n_date_interval_h

date_interval

)

Destroys the date interval object.

Since :

5.0

Parameters:

[in]

date_interval

The date interval to be destroyed

Returns:

0 on success, otherwise a negative error value

Return values:

I18N_ERROR_NONE	Successful
I18N_ERROR_INVALID_PARAMETER	Invalid function parameter

int i18n_date_interval_equals	(	i18n_date_interval_h	date_interval_1,
		i18n_date_interval_h	date_interval_2,
		i18n_ubool *	equals
	)

Compares two date interval objects.

Since :

5.0

Parameters:

[in]	date_interval_1	The first date interval object
[in]	date_interval_2	The second date interval object
[out]	equals	A flag set to true if given objects are equal, or false otherwise.

Returns:

0 on success, otherwise a negative error value

Return values:

I18N_ERROR_NONE	Successful
I18N_ERROR_INVALID_PARAMETER	Invalid function parameter

int i18n_date_interval_get_from_date	(	i18n_date_interval_h	date_interval,
		i18n_udate *	from_date
	)

Gets the 'from date' from a given date interval object.

Since :

5.0

Parameters:

[in]	date_interval	The date interval object
[out]	from_date	The 'from date' value

Returns:

0 on success, otherwise a negative error value

Return values:

I18N_ERROR_NONE	Successful
I18N_ERROR_INVALID_PARAMETER	Invalid function parameter

int i18n_date_interval_get_to_date	(	i18n_date_interval_h	date_interval,
		i18n_udate *	to_date
	)

Gets the 'to date' from a given date interval object.

Since :

5.0

Parameters:

[in]	date_interval	The date interval object
[out]	to_date	The 'to date' value

Returns:

0 on success, otherwise a negative error value

Return values:

I18N_ERROR_NONE	Successful
I18N_ERROR_INVALID_PARAMETER	Invalid function parameter