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.
|
The calendar filter API provides the set of the definitions and interfaces that enable you to handle filter.
Required Header
#include <calendar.h>
Define Documentation
Definition for all calendar books.
- Since :
- 2.3
Enumeration Type Documentation
Enumeration for a filter operator.
- Since :
- 2.3
- Enumerator:
CALENDAR_FILTER_OPERATOR_AND |
AND
|
CALENDAR_FILTER_OPERATOR_OR |
OR
|
CALENDAR_FILTER_OPERATOR_MAX |
Calendar filter operator max enum count
|
Enumeration for the filter match type of an integer.
- Since :
- 2.3
- Enumerator:
CALENDAR_MATCH_EQUAL |
'='
|
CALENDAR_MATCH_GREATER_THAN |
'>'
|
CALENDAR_MATCH_GREATER_THAN_OR_EQUAL |
'>='
|
CALENDAR_MATCH_LESS_THAN |
'<'
|
CALENDAR_MATCH_LESS_THAN_OR_EQUAL |
'<='
|
CALENDAR_MATCH_NOT_EQUAL |
'<>', this flag can yield poor performance
|
CALENDAR_MATCH_NONE |
IS NULL
|
CALENDAR_MATCH_INT_MAX |
Calendar match integer flag max enum count
|
Enumeration for the filter match type of a string.
- Since :
- 2.3
- Enumerator:
CALENDAR_MATCH_EXACTLY |
Full string, case-sensitive
|
CALENDAR_MATCH_FULLSTRING |
Full string, case-insensitive
|
CALENDAR_MATCH_CONTAINS |
Sub string, case-insensitive
|
CALENDAR_MATCH_STARTSWITH |
Start with, case-insensitive
|
CALENDAR_MATCH_ENDSWITH |
End with, case-insensitive
|
CALENDAR_MATCH_EXISTS |
IS NOT NULL
|
CALENDAR_MATCH_STR_MAX |
Calendar match string flag max enum count
|
Function Documentation
Adds a condition for the calendar_time_s type property.
- Since :
- 2.3
- 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:
-
- See also:
- calendar_filter_add_operator()
Adds a condition for the double type property.
- Since :
- 2.3
- 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:
-
- See also:
- calendar_filter_add_operator()
Adds a child filter to a parent filter.
- Since :
- 2.3
- 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:
-
- See also:
- calendar_filter_add_operator()
Adds a condition for the integer type property.
- Since :
- 2.3
- 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:
-
- See also:
- calendar_filter_add_operator()
Adds a condition for the long long int type property.
- Since :
- 2.3
- 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:
-
- See also:
- calendar_filter_add_operator()
Adds a condition for the string type property.
- Since :
- 2.3
- 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:
-
- See also:
- calendar_filter_add_operator()
Creates a filter handle.
- Since :
- 2.3
- 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:
-
- Precondition:
- calendar_connect() should be called to initialize.
- See also:
- calendar_filter_destroy()
Destroys a filter handle.
- Since :
- 2.3
- Parameters:
-
[in] | filter | The filter handle |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
- See also:
- calendar_filter_create()