Read Item
[API's]

Functions

alp_status_t alp_calendar_dml_events_from_vCal_buffer (AlpDmlH dmlH, char *dataBuf, bool fromExgMgr, GList **eventIDs) __attribute((deprecated))

Deprecated. Use alp_calendar_dml_read_from_vCal_buffer.

alp_status_t alp_calendar_dml_events_from_vCal_file (AlpDmlH dmlH, int theDataFd, bool fromExgMgr, GList **eventIDs) __attribute((deprecated))

Deprecated. Use alp_calendar_dml_read_from_vCal_file instead.

alp_status_t alp_calendar_dml_events_to_vCal_buffer (AlpDmlH dmlH, uint8_t **dataBuf, uint32_t *size, bool toExgMgr, GList *eventIDs) __attribute((deprecated))

Deprecated. Use alp_calendar_dml_write_to_vCal_buffer instead.

alp_status_t alp_calendar_dml_events_to_vCal_file (AlpDmlH dmlH, int theDataFd, bool toExgMgr, GList *eventIDs) __attribute((deprecated))

Deprecated. Use alp_calendar_dml_write_to_vCal_file instead.

alp_status_t alp_calendar_dml_get_item (AlpDmlH dmlH, AlpLuid itemLuid, AlpDmlStatementH *stmtH)

This API call can be used to fetch details of a given event specified by its LUID A call to alp_calendar_dml_statement_next needs to be made before fetching any values for the desired row. using the statement handle returned.

alp_status_t alp_calendar_dml_read_from_vCal_buffer (AlpDmlH dmlH, const uint8_t *dataBuf, uint32_t size, bool fromExgMgr, bool forModify, GList **eventLuids)

Creates one or more calendar events from the contents of a buffer containing vCals.

alp_status_t alp_calendar_dml_read_from_vCal_file (AlpDmlH dmlH, int theDataFd, bool fromExgMgr, bool forModify, GList **eventLuids)

Creates one or more calendar events from the contents of a file containing vCals.

alp_status_t alp_calendar_dml_search_begin (AlpDmlH dmlH, AlpDmlStatementH *stmtH, const char *search_string, int32_t *numResults)

This API call can be used to search events in calendar database.

alp_status_t alp_calendar_dml_search_statement_begin (AlpDmlH dml, AlpDmlStatementH *stmtH, const char *search_string, int32_t *numResults) __attribute((deprecated))

Deprecated. Call alp_calendar_dml_search_begin instead.

alp_status_t alp_calendar_dml_statement_begin (AlpDmlH dmlH, AlpLuid eventLuid, AlpDmlStatementH *stmtH, uint32_t categoryLUID, bool unfiled, DateTimeType startTime, DateTimeType endTime, const char *orderBy, int32_t *numResults)

This API call can be used to fetch events in calendar database filtered based on three criteria 1. Filter based on category 2. Filter based on event starttime and event endtime 3. Filter based on event luid.

alp_status_t alp_calendar_dml_statement_end (AlpDmlH dmlH, AlpDmlStatementH stmt) __attribute((deprecated))

Temporarily deprecated. Use alp_calendar_dml_statement_end_new.

alp_status_t alp_calendar_dml_statement_end_new (AlpDmlStatementH stmt)

This API call is used to end a query that was begun in call to alp_calendar_dml_statement_begin.

alp_status_t alp_calendar_dml_statement_get_blob (AlpDmlStatementH stmtH, AlpCalendarDmlColumnType column, bool copy, void **value, int32_t *size)

This API call is used to fetch the blob value for a given field.

alp_status_t alp_calendar_dml_statement_get_int32 (AlpDmlStatementH stmtH, AlpCalendarDmlColumnType column, uint32_t *value)

This API call is used to fetch the integer value for a given field.

alp_status_t alp_calendar_dml_statement_get_string (AlpDmlStatementH stmtH, AlpCalendarDmlColumnType column, bool copy, char **value)

This API call is used to fetch the text value for a given field.

alp_status_t alp_calendar_dml_statement_next (AlpDmlH dmlH, AlpDmlStatementH *stmtH) __attribute((deprecated))

Temporarily deprecated, use alp_calendar_dml_statement_next_new.

alp_status_t alp_calendar_dml_statement_next_new (AlpDmlStatementH *stmtH)

This API call is used to fetch the next event from the query results( started by a alp_calendar_dml_statement_begin call).

alp_status_t alp_calendar_dml_write_to_vCal_buffer (AlpDmlH dmlH, uint8_t **dataBuf, uint32_t *size, bool toExgMgr, const GList *eventLuids)

Writes one or more calendar vCals to an allocated buffer.

alp_status_t alp_calendar_dml_write_to_vCal_file (AlpDmlH dmlH, int theDataFd, bool toExgMgr, const GList *eventLuids)

Writes one or more vCals to the given file.

Function Documentation

alp_status_t alp_calendar_dml_events_from_vCal_buffer ( AlpDmlH dmlH,

char * dataBuf,

bool fromExgMgr,

GList ** eventIDs

)

Deprecated. Use alp_calendar_dml_read_from_vCal_buffer.

alp_status_t alp_calendar_dml_events_from_vCal_file ( AlpDmlH dmlH,

int theDataFd,

bool fromExgMgr,

GList ** eventIDs

)

Deprecated. Use alp_calendar_dml_read_from_vCal_file instead.

alp_status_t alp_calendar_dml_events_to_vCal_buffer ( AlpDmlH dmlH,

uint8_t ** dataBuf,

uint32_t * size,

bool toExgMgr,

GList * eventIDs

)

Deprecated. Use alp_calendar_dml_write_to_vCal_buffer instead.

alp_status_t alp_calendar_dml_events_to_vCal_file ( AlpDmlH dmlH,

int theDataFd,

bool toExgMgr,

GList * eventIDs

)

Deprecated. Use alp_calendar_dml_write_to_vCal_file instead.

alp_status_t alp_calendar_dml_get_item ( AlpDmlH dmlH,

AlpLuid itemLuid,

AlpDmlStatementH * stmtH

)

This API call can be used to fetch details of a given event specified by its LUID A call to alp_calendar_dml_statement_next needs to be made before fetching any values for the desired row. using the statement handle returned.

Parameters:

[in] dmlH Calendar data model handle

[out] itemLuid,: LUID of the record

[out] stmtH,: pointer to statement structure that will be returned on output

Returns:
alp_status_t

alp_status_t alp_calendar_dml_read_from_vCal_buffer ( AlpDmlH dmlH,

const uint8_t * dataBuf,

uint32_t size,

bool fromExgMgr,

bool forModify,

GList ** eventLuids

)

Creates one or more calendar events from the contents of a buffer containing vCals.
If a given vCal contains the GUID of an existing event, and we are called to handle an exchange manager request, than that data will replace what is already in the database. Otherwise this function creates new events for each vCal.

Parameters:

[in] dmlH Handle to the calendar data model handle.

[in] dataBuf Buffer containing vCal data.

[in] size Size of dataBuf, or -1 if dataBuf is NULL-terminated.

[in] fromExgMgr true iff we are called to handle an exchange manager request

[in] forModify true if the returned items may be modified

[out] eventLuids Created list of AlpLuid's of all the events created. This must be disposed of by the caller.

Returns:
ALP_STATUS_CALENDAR_DML_* error

alp_status_t alp_calendar_dml_read_from_vCal_file ( AlpDmlH dmlH,

int theDataFd,

bool fromExgMgr,

bool forModify,

GList ** eventLuids

)

Creates one or more calendar events from the contents of a file containing vCals.
If a given vCal contains the GUID of an existing event, and we are called to handle an exchange manager request, than that data will replace what is already in the database. Otherwise this function creates new events for each vCal.

Parameters:

[in] dmlH Handle to the calendar data model handle.

[in] theDataFd The opened files descriptor of the file containing the vCal(s). Must be opened and closed by the caller.

[in] fromExgMgr true iff we are called to handle an exchange manager request

[out] eventLuids Created list of AlpLuid's of all the events created. This must be disposed of by the caller.

Returns:
ALP_STATUS_CALENDAR_DML_* error

alp_status_t alp_calendar_dml_search_begin ( AlpDmlH dmlH,

AlpDmlStatementH * stmtH,

const char * search_string,

int32_t * numResults

)

This API call can be used to search events in calendar database.

Parameters:

[in] dmlH calendar data model handle

[out] stmtH,: AlpSALStatement handlecountClauSmartJoinInfose

[in] search_string,: string to match. This searches two fields - description, location and it is caseless.

[out] numResults,: The number of records matching the search criteria.

Returns:
alp_status_t

See also:
alp_calendar_dml_get_next_event

alp_status_t alp_calendar_dml_search_statement_begin ( AlpDmlH dml,

AlpDmlStatementH * stmtH,

const char * search_string,

int32_t * numResults

)

Deprecated. Call alp_calendar_dml_search_begin instead.

alp_status_t alp_calendar_dml_statement_begin ( AlpDmlH dmlH,

AlpLuid eventLuid,

AlpDmlStatementH * stmtH,

uint32_t categoryLUID,

bool unfiled,

DateTimeType startTime,

DateTimeType endTime,

const char * orderBy,

int32_t * numResults

)

This API call can be used to fetch events in calendar database filtered based on three criteria 1. Filter based on category 2. Filter based on event starttime and event endtime 3. Filter based on event luid.

Parameters:

[in] dmlH calendar data model handle

[in] eventLuid LUID of a given event, if requesting data for a specific event

[out] stmtH,: AlpSALStatement handle

[in] categoryLUID,: Filter to only select records that are a member of the given categoryLUID. If 0, then this parameter is ignored.

[in] unfiled if true, then categoryLuid is ignored and only events that have no category memberships are allowed.

[in] startTime starting time of the range

[in] endTime : end time of the range

[in] orderBy,: Comma separated string list of fields to order by (e.g. "StartDateTime, EndDateTime")

[out] numResults,: The number of records matching the categoryLUID and range filters.

Returns:
alp_status_t

See also:
alp_calendar_dml_statement_next
alp_calendar_dml_statement_end

alp_status_t alp_calendar_dml_statement_end ( AlpDmlH dmlH,

AlpDmlStatementH stmt

)

Temporarily deprecated. Use alp_calendar_dml_statement_end_new.
This function is temporarily deprecated for Alp 2.4 in favor of alp_calendar_dml_statement_end_new(), which has the correct function signature but a suboptimal name. For Alp 2.5, this new function will be deprecated and the old function's signature changed. Please either migrate to the new function, or wait for Alp 2.5 to change all calls of this function to the new signature.

alp_status_t alp_calendar_dml_statement_end_new ( AlpDmlStatementH stmt )

This API call is used to end a query that was begun in call to alp_calendar_dml_statement_begin.

Parameters:

[in] stmt statement AlpSALStatement handle returned from a alp_calendar_dml_statement_begin call

Returns:
alp_status_t

See also:
alp_calendar_dml_statement_begin
alp_calendar_dml_statement_next

alp_status_t alp_calendar_dml_statement_get_blob ( AlpDmlStatementH stmtH,

AlpCalendarDmlColumnType column,

bool copy,

void ** value,

int32_t * size

)

This API call is used to fetch the blob value for a given field.

Parameters:

[in] stmtH handle to the statement returned from a call to alp_calendar_dml_statement_next

[in] column,: enum of the field specified by AlpCalendarDmlColumnType. for eg., kRepeatFrequency

[in] copy : boolean value indicating whether to copy the text value or just pass the pointer from the database

[out] value : blob value of the field in the record.

[out] size : size of the blob returned in value field

Returns:
alp_status_t

alp_status_t alp_calendar_dml_statement_get_int32 ( AlpDmlStatementH stmtH,

AlpCalendarDmlColumnType column,

uint32_t * value

)

This API call is used to fetch the integer value for a given field.

Parameters:

[in] stmtH handle to the statement returned from a call to alp_calendar_dml_get_events_by_time_category

[in] column,: enum of the field specified by AlpCalendarDmlColumnType. for eg., kDescription

[out] value : int32_t value of the field in the record.

Returns:
alp_status_t

alp_status_t alp_calendar_dml_statement_get_string ( AlpDmlStatementH stmtH,

AlpCalendarDmlColumnType column,

bool copy,

char ** value

)

This API call is used to fetch the text value for a given field.

Parameters:

[in] stmtH handle to the statement structure returned from a call to alp_calendar_dml_statement_next

[in] column,: enum of the field specified by AlpCalendarDmlColumnType. for eg., kExceptionDates

[in] copy : boolean value indicating whether ot copy the text value or just pass the pointer from the database

[out] value : text value of the field in the record.

Returns:
alp_status_t

alp_status_t alp_calendar_dml_statement_next ( AlpDmlH dmlH,

AlpDmlStatementH * stmtH

)

Temporarily deprecated, use alp_calendar_dml_statement_next_new.
This function is temporarily deprecated for Alp 2.4 in favor of alp_calendar_dml_statement_next_new(), which has the correct function signature but a suboptimal name. For Alp 2.5, this new function will be deprecated and the old function's signature changed. Please either migrate to the new function, or wait for Alp 2.5 to change all calls of this function to the new signature.

alp_status_t alp_calendar_dml_statement_next_new ( AlpDmlStatementH * stmtH )

This API call is used to fetch the next event from the query results( started by a alp_calendar_dml_statement_begin call).

Parameters:

[in] stmtH statement handle returned by a previous call to alp_calendar_dml_statement_begin.

Returns:
alp_status_t

See also:
alp_calendar_dml_statement_begin
alp_calendar_dml_statement_end

alp_status_t alp_calendar_dml_write_to_vCal_buffer ( AlpDmlH dmlH,

uint8_t ** dataBuf,

uint32_t * size,

bool toExgMgr,

const GList * eventLuids

)

Writes one or more calendar vCals to an allocated buffer.
If called to handle an exchange manager request we'll add the GUID to the vCal.

Parameters:

[in] dmlH Handle to the calendar data model handle.

[out] dataBuf Allocated buffer of vCal's. NULL terminated. Must be free'd by the caller.

[out] size - size of buffer in dataBuf param to be returned

[in] toExgMgr true iff we are called to handle an exchange manager request

[in] eventLuids List of AlpLuid's of all the events to write.

Returns:
ALP_STATUS_CALENDAR_DML_* error

alp_status_t alp_calendar_dml_write_to_vCal_file ( AlpDmlH dmlH,

int theDataFd,

bool toExgMgr,

const GList * eventLuids

)

Writes one or more vCals to the given file.
If called to handle an exchange manager request we'll add the GUID to the vCal.

Parameters:

[in] dmlH Handle to the calendar data model handle.

[in] theDataFd The opened files descriptor of the file containing the vCal(s). Must be opened and closed by the caller.

[in] toExgMgr true iff we are called to handle an exchange manager request

[in] eventLuids List of AlpLuid's of all the events to write.

Returns:
ALP_STATUS_CALENDAR_DML_* error

Generated on Wed Jul 30 07:06:41 2008 by Doxygen 1.4.6 for ALP SDK + Hiker Documentation


Functions
alp_status_t	alp_calendar_dml_events_from_vCal_buffer (AlpDmlH dmlH, char dataBuf, bool fromExgMgr, GList *eventIDs) __attribute((deprecated))
	Deprecated. Use alp_calendar_dml_read_from_vCal_buffer.
alp_status_t	alp_calendar_dml_events_from_vCal_file (AlpDmlH dmlH, int theDataFd, bool fromExgMgr, GList **eventIDs) __attribute((deprecated))
	Deprecated. Use alp_calendar_dml_read_from_vCal_file instead.
alp_status_t	alp_calendar_dml_events_to_vCal_buffer (AlpDmlH dmlH, uint8_t *dataBuf, uint32_t size, bool toExgMgr, GList *eventIDs) __attribute((deprecated))
	Deprecated. Use alp_calendar_dml_write_to_vCal_buffer instead.
alp_status_t	alp_calendar_dml_events_to_vCal_file (AlpDmlH dmlH, int theDataFd, bool toExgMgr, GList *eventIDs) __attribute((deprecated))
	Deprecated. Use alp_calendar_dml_write_to_vCal_file instead.
alp_status_t	alp_calendar_dml_get_item (AlpDmlH dmlH, AlpLuid itemLuid, AlpDmlStatementH *stmtH)
	This API call can be used to fetch details of a given event specified by its LUID A call to alp_calendar_dml_statement_next needs to be made before fetching any values for the desired row. using the statement handle returned.
alp_status_t	alp_calendar_dml_read_from_vCal_buffer (AlpDmlH dmlH, const uint8_t dataBuf, uint32_t size, bool fromExgMgr, bool forModify, GList *eventLuids)
	Creates one or more calendar events from the contents of a buffer containing vCals.
alp_status_t	alp_calendar_dml_read_from_vCal_file (AlpDmlH dmlH, int theDataFd, bool fromExgMgr, bool forModify, GList **eventLuids)
	Creates one or more calendar events from the contents of a file containing vCals.
alp_status_t	alp_calendar_dml_search_begin (AlpDmlH dmlH, AlpDmlStatementH stmtH, const char search_string, int32_t *numResults)
	This API call can be used to search events in calendar database.
alp_status_t	alp_calendar_dml_search_statement_begin (AlpDmlH dml, AlpDmlStatementH stmtH, const char search_string, int32_t *numResults) __attribute((deprecated))
	Deprecated. Call alp_calendar_dml_search_begin instead.
alp_status_t	alp_calendar_dml_statement_begin (AlpDmlH dmlH, AlpLuid eventLuid, AlpDmlStatementH stmtH, uint32_t categoryLUID, bool unfiled, DateTimeType startTime, DateTimeType endTime, const char orderBy, int32_t *numResults)
	This API call can be used to fetch events in calendar database filtered based on three criteria 1. Filter based on category 2. Filter based on event starttime and event endtime 3. Filter based on event luid.
alp_status_t	alp_calendar_dml_statement_end (AlpDmlH dmlH, AlpDmlStatementH stmt) __attribute((deprecated))
	Temporarily deprecated. Use alp_calendar_dml_statement_end_new.
alp_status_t	alp_calendar_dml_statement_end_new (AlpDmlStatementH stmt)
	This API call is used to end a query that was begun in call to alp_calendar_dml_statement_begin.
alp_status_t	alp_calendar_dml_statement_get_blob (AlpDmlStatementH stmtH, AlpCalendarDmlColumnType column, bool copy, void *value, int32_t size)
	This API call is used to fetch the blob value for a given field.
alp_status_t	alp_calendar_dml_statement_get_int32 (AlpDmlStatementH stmtH, AlpCalendarDmlColumnType column, uint32_t *value)
	This API call is used to fetch the integer value for a given field.
alp_status_t	alp_calendar_dml_statement_get_string (AlpDmlStatementH stmtH, AlpCalendarDmlColumnType column, bool copy, char **value)
	This API call is used to fetch the text value for a given field.
alp_status_t	alp_calendar_dml_statement_next (AlpDmlH dmlH, AlpDmlStatementH *stmtH) __attribute((deprecated))
	Temporarily deprecated, use alp_calendar_dml_statement_next_new.
alp_status_t	alp_calendar_dml_statement_next_new (AlpDmlStatementH *stmtH)
	This API call is used to fetch the next event from the query results( started by a alp_calendar_dml_statement_begin call).
alp_status_t	alp_calendar_dml_write_to_vCal_buffer (AlpDmlH dmlH, uint8_t *dataBuf, uint32_t size, bool toExgMgr, const GList *eventLuids)
	Writes one or more calendar vCals to an allocated buffer.
alp_status_t	alp_calendar_dml_write_to_vCal_file (AlpDmlH dmlH, int theDataFd, bool toExgMgr, const GList *eventLuids)
	Writes one or more vCals to the given file.

Read Item [API's]

Functions

Function Documentation

Read Item
[API's]