Alarm Manager
[System]


Errors

#define ALP_STATUS_ALARM_BAD_PARAM   (ALP_CLASS_ALARM | 0x00020000)
 Supplied application ID is invalid, either being NULL or exceeding ALP_ALARM_MAX_APPID_SIZE or requested alarm time has already passed.
#define ALP_STATUS_ALARM_IPC   (ALP_CLASS_ALARM | 0x00030000)
 IPC error occurred during function call.
#define ALP_STATUS_ALARM_NO_MEMORY   (ALP_CLASS_ALARM | 0x00010000)
 Unable to allocation memory to complete function call.

Defines

#define ALP_ALARM_MAX_APPID_SIZE   64
 Maximum size of an application ID.
#define ALP_ALARM_REASON_NORMAL   "normal"
 normal alarm expiration
#define ALP_ALARM_REASON_RESTART   "restart"
 alarm expired prior to alarm manager (re)start
#define ALP_ALARM_REASON_SYSTIME_CHANGE   "time-change"
 systime change caused alarm to expire earlier than expected

Functions

alp_status_t alp_alarm_get (const gchar *appID, guint32 ref, guint32 *alarmSeconds)
 Return the current setting for an alarm.
alp_status_t alp_alarm_set (const gchar *appID, guint32 ref, guint32 alarmSeconds)
 Set or cancel an alarm for the given application.

Define Documentation

#define ALP_ALARM_MAX_APPID_SIZE   64
 

Maximum size of an application ID.

#define ALP_ALARM_REASON_NORMAL   "normal"
 

normal alarm expiration

#define ALP_ALARM_REASON_RESTART   "restart"
 

alarm expired prior to alarm manager (re)start

#define ALP_ALARM_REASON_SYSTIME_CHANGE   "time-change"
 

systime change caused alarm to expire earlier than expected

#define ALP_STATUS_ALARM_BAD_PARAM   (ALP_CLASS_ALARM | 0x00020000)
 

Supplied application ID is invalid, either being NULL or exceeding ALP_ALARM_MAX_APPID_SIZE or requested alarm time has already passed.

#define ALP_STATUS_ALARM_IPC   (ALP_CLASS_ALARM | 0x00030000)
 

IPC error occurred during function call.

#define ALP_STATUS_ALARM_NO_MEMORY   (ALP_CLASS_ALARM | 0x00010000)
 

Unable to allocation memory to complete function call.

Function Documentation

alp_status_t alp_alarm_get (  const gchar *  appID,
guint32  ref,
guint32 *  alarmSeconds
) 
 

Return the current setting for an alarm.

Returns the date and time in seconds since 01/01/1970 UTC for the given application ID and alarm reference number.

Parameters:
[in] appID Package name of the calling application.
[in] ref Caller-defined value.
[out] alarmSeconds Pointer to location to hold the time value set for the specified alarm. The time value represents the number of seconds since 01/01/1970 UTC; if no alarm is active for the application, 0 is returned for the alarm seconds.
Returns:
ALP_STATUS_OK if no error occurred during call

ALP_STATUS_ALARM_BAD_PARAM if invalid parameters are passed such as a NULL for appId or alarmSeconds

ALP_STATUS_ALARM_IPC if an IPC error occurred during the call

alp_status_t alp_alarm_set (  const gchar *  appID,
guint32  ref,
guint32  alarmSeconds
) 
 

Set or cancel an alarm for the given application.

Parameters:
[in] appID Package name of the calling application.
[in] ref Caller-defined value.
[in] alarmSeconds Specifies the date/time in seconds since 01/01/1970 UTC at which the alarm will be triggered, or 0 to cancel the alarm specified by ref if any
Returns:
ALP_STATUS_OK if no error occurred during call

ALP_STATUS_ALARM_BAD_PARAM if invalid parameters are passed such as a NULL for appId

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

Copyright © 1999-2008 ACCESS CO., LTD. All rights reserved.