icap_list_alarms

(PHP 4 >= 4.0b4)

icap_list_alarms --  Return a list of events that has an alarm triggered at the given datetime

Description

int icap_list_alarms (int stream_id, array date, array time)

Returns an array of event ID's that has an alarm going off at the given datetime.

icap_list_alarms() function takes in a datetime for a calendar stream. An array of event id's that has an alarm should be going off at the datetime are returned.

All datetime entries consist of an object that contains: