The calendar query API provides the set of the definitions and interfaces that enable you to handle query.
Required Header
#include <calendar.h>
Function Documentation
Creates a query handle.
- Since :
- 2.3
- Parameters:
-
[in] | view_uri | The view URI of a query |
[out] | query | 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_query_destroy()
Destroys a query handle.
- Since :
- 2.3
- Parameters:
-
[in] | query | The query handle |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
- See also:
- calendar_query_create()
Sets the "distinct" option for projection.
- Since :
- 2.3
- Parameters:
-
[in] | query | The query handle |
[in] | set | If true it is set, otherwise if false it is unset |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
Sets the filter for a query.
- Since :
- 2.3
- Parameters:
-
[in] | query | The query handle |
[in] | filter | The filter handle |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
- See also:
- calendar_query_add_operator()
Adds property IDs for projection.
Property IDs can be of one of the properties of view_uri which is used in calendar_query_create().
- Since :
- 2.3
- Parameters:
-
[in] | query | The query handle |
[in] | property_id_array | The property ID array |
[in] | count | The number of property IDs |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
Sets the sort mode for a query.
- Since :
- 2.3
- Parameters:
-
[in] | query | The query handle |
[in] | property_id | The property ID to sort |
[in] | is_ascending | If true it sorts in the ascending order, otherwise if false it sorts in the descending order |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-