vmalarm_sdk.h
4.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
/*****************************************************************************
* Copyright Statement:
* --------------------
* This software is protected by Copyright and the information contained
* herein is confidential. The software may not be copied and the information
* contained herein may not be used or disclosed except with the written
* permission of MediaTek Inc. (C) 2005
*
* BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
* THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
* RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER ON
* AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
* NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
* SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
* SUPPLIED WITH THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH
* THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO
* NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S
* SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM.
*
* BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE
* LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
* AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE,
* OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO
* MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
*
* THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE
* WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF
* LAWS PRINCIPLES. ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND
* RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER
* THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC).
*
*****************************************************************************/
#ifndef VMALARM_SDK_H_
#define VMALARM_SDK_H_
#ifdef __cplusplus
extern "C" {
#endif
#include "vmsys.h"
typedef struct
{
VMUINT16 nYear;
VMUINT8 nMonth;
VMUINT8 nDay;
VMUINT8 nHour;
VMUINT8 nMin;
VMUINT8 nSec;
VMUINT8 DayIndex; /* reserved*/
} vm_alarm_time_struct;
typedef enum
{
VM_ALARM_ERROR_INVALID_ID = -6, // invalid alarm id
VM_ALARM_ERROR_INVALID_TIME, // invalid alarm time. For example: set time is earlier than current phone time
VM_ALARM_ERROR_OF_PROCESS, // the operated alarm does not belong to current app
VM_ALARM_ERROR_OF_RES , // exceed to alarm resource limitation, the max value is 10
VM_ALARM_ERROR_OF_MEM , // memory is not enough for alarm operation
VM_ALARM_ERROR , // native alarm error
VM_ALARM_OK // success
} vm_alarm_error_t;
/* alarm expire callback function prototype */
typedef void (*VM_ALARMPROC_T)(VMINT alarm_id);
/******************************************************************************
* FUNCTION
* vm_alarm_set
* DESCRIPTION
* set alarm with a dedicated time and expire callback function, the set time must be later than current phone time.
* When the set time expire, the expire callback function will be executed
* PARAMETERS
* expire_time : [IN] set time
* alarm_proc : [IN] expire callback function
* RETURNS
* if succeed, return VM_ALARM_OK ,otherwise, return error code
*****************************************************************************/
VMINT vm_alarm_set(vm_alarm_time_struct* expire_time, VM_ALARMPROC_T alarm_proc);
/******************************************************************************
* FUNCTION
* vm_alarm_cancel
* DESCRIPTION
* cancel alarm. If the alarm has expire, this cancel operation will do nothing
* PARAMETERS
* alarm_id : [IN] alarm id
* RETURNS
* if succeed, return VM_ALARM_OK ,otherwise, return error code
*****************************************************************************/
VMINT vm_alarm_cancel(VMINT alarm_id);
#ifdef __cplusplus
}
#endif
#endif /* VMALARM_SDK_H_ */