Tizen Native API
5.0
|
The calendar filter API provides the set of the definitions and interfaces that enable you to handle filter.
Required Header
#include <calendar.h>
Functions | |
int | calendar_filter_create (const char *view_uri, calendar_filter_h *filter) |
Creates a filter handle. | |
int | calendar_filter_destroy (calendar_filter_h filter) |
Destroys a filter handle. | |
int | calendar_filter_add_str (calendar_filter_h filter, unsigned int property_id, calendar_match_str_flag_e match, const char *match_value) |
Adds a condition for the string type property. | |
int | calendar_filter_add_int (calendar_filter_h filter, unsigned int property_id, calendar_match_int_flag_e match, int match_value) |
Adds a condition for the integer type property. | |
int | calendar_filter_add_double (calendar_filter_h filter, unsigned int property_id, calendar_match_int_flag_e match, double match_value) |
Adds a condition for the double type property. | |
int | calendar_filter_add_lli (calendar_filter_h filter, unsigned int property_id, calendar_match_int_flag_e match, long long int match_value) |
Adds a condition for the long long int type property. | |
int | calendar_filter_add_caltime (calendar_filter_h filter, unsigned int property_id, calendar_match_int_flag_e match, calendar_time_s match_value) |
Adds a condition for the calendar_time_s type property. | |
int | calendar_filter_add_filter (calendar_filter_h parent_filter, calendar_filter_h child_filter) |
Adds a child filter to a parent filter. | |
int | calendar_filter_add_operator (calendar_filter_h filter, calendar_filter_operator_e operator_type) |
Adds an operator between conditions. | |
Defines | |
#define | CALENDAR_BOOK_FILTER_ALL -1 |
Definition for all calendar books. |
Define Documentation
#define CALENDAR_BOOK_FILTER_ALL -1 |
Definition for all calendar books.
- Since :
- 3.0
Enumeration Type Documentation
Enumeration for the filter match type of an integer.
- Since :
- 3.0
- Enumerator:
Enumeration for the filter match type of a string.
- Since :
- 3.0
- Enumerator:
Function Documentation
int calendar_filter_add_caltime | ( | calendar_filter_h | filter, |
unsigned int | property_id, | ||
calendar_match_int_flag_e | match, | ||
calendar_time_s | match_value | ||
) |
Adds a condition for the calendar_time_s type property.
- Since :
- 3.0
- Parameters:
-
[in] filter The filter handle [in] property_id The property ID to add a condition [in] match The match flag [in] match_value The match value
- 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
- See also:
- calendar_filter_add_operator()
int calendar_filter_add_double | ( | calendar_filter_h | filter, |
unsigned int | property_id, | ||
calendar_match_int_flag_e | match, | ||
double | match_value | ||
) |
Adds a condition for the double type property.
- Since :
- 3.0
- Parameters:
-
[in] filter The filter handle [in] property_id The property ID to add a condition [in] match The match flag [in] match_value The match value
- 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
- See also:
- calendar_filter_add_operator()
int calendar_filter_add_filter | ( | calendar_filter_h | parent_filter, |
calendar_filter_h | child_filter | ||
) |
Adds a child filter to a parent filter.
- Since :
- 3.0
- Parameters:
-
[in] parent_filter The parent filter handle [in] child_filter The child filter handle
- 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
- See also:
- calendar_filter_add_operator()
int calendar_filter_add_int | ( | calendar_filter_h | filter, |
unsigned int | property_id, | ||
calendar_match_int_flag_e | match, | ||
int | match_value | ||
) |
Adds a condition for the integer type property.
- Since :
- 3.0
- Parameters:
-
[in] filter The filter handle [in] property_id The property ID to add a condition [in] match The match flag [in] match_value The match value
- 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
- See also:
- calendar_filter_add_operator()
int calendar_filter_add_lli | ( | calendar_filter_h | filter, |
unsigned int | property_id, | ||
calendar_match_int_flag_e | match, | ||
long long int | match_value | ||
) |
Adds a condition for the long long int type property.
- Since :
- 3.0
- Parameters:
-
[in] filter The filter handle [in] property_id The property ID to add a condition [in] match The match flag [in] match_value The match value
- 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
- See also:
- calendar_filter_add_operator()
int calendar_filter_add_operator | ( | calendar_filter_h | filter, |
calendar_filter_operator_e | operator_type | ||
) |
Adds an operator between conditions.
- Since :
- 3.0
- Parameters:
-
[in] filter The filter handle [in] operator_type The operator type
- 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_filter_add_str | ( | calendar_filter_h | filter, |
unsigned int | property_id, | ||
calendar_match_str_flag_e | match, | ||
const char * | match_value | ||
) |
Adds a condition for the string type property.
- Since :
- 3.0
- Parameters:
-
[in] filter The filter handle [in] property_id The property ID to add a condition [in] match The match flag [in] match_value The match value
- 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
- See also:
- calendar_filter_add_operator()
int calendar_filter_create | ( | const char * | view_uri, |
calendar_filter_h * | filter | ||
) |
Creates a filter handle.
- Since :
- 3.0
- Remarks:
- You must release filter using calendar_filter_destroy().
- Parameters:
-
[in] view_uri The view URI of a filter [out] filter The filter handle
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
CALENDAR_ERROR_NONE Successful CALENDAR_ERROR_INVALID_PARAMETER Invalid parameter CALENDAR_ERROR_OUT_OF_MEMORY Out of memory CALENDAR_ERROR_SYSTEM Internal system module error CALENDAR_ERROR_NOT_SUPPORTED Not supported
- Precondition:
- calendar_connect() should be called to initialize.
- See also:
- calendar_filter_destroy()
int calendar_filter_destroy | ( | calendar_filter_h | filter | ) |
Destroys a filter handle.
- Since :
- 3.0
- Parameters:
-
[in] filter The filter handle
- 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
- See also:
- calendar_filter_create()