SFBAlarmMgr

IAlarmMgr インターフェースのラッパークラスです。

#include <SFBAlarmMgr.h.hpp>

class SFBAlarmMgr : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBAlarmMgr)

継承図

バージョン

BREW 2.0	BREW 2.1	BREW 3.1	BREW 4.0
×	×	×	○

参照

BREW API IAlarmMgr

メンバ

パブリック関数
`SFCError`	AlarmsActive( `AEECLSID` clsid ) この関数に渡された ClassID で指定されたアプリケーション用にアラームが設定されている場合に SUCCESS を返します。 ClassID がゼロの場合、この関数は現在実行中のアプリケーションの結果を返します。 ClassID がゼロ以外であり、現在のアプリケーションでない場合、コール側は AEEGROUPID_ALARM_ALL の特権レベルを持っている必要があります。
`SFCError`	CancelAlarm( `AEECLSID` clsid , `UInt16` usercode ) SFBALARMMGR::SetAlarm() または SFBSHELL::SetAlarm() で設定されたアラームをキャンセルします。
`UInt16`	GetUserCode( `UInt32` usercode ) ユーザーコードを取得します。
`Bool`	IsCodeReserved( `UInt16` usercode ) 指定されたユーザーコードが、コール側アプリケーションによって予約されているかをチェックします。
`SFCError`	ListAlarmCodes( `AEECLSID` clsid , `UInt16Ptr` usercodes , `UInt32Ptr` count ) アプリケーション用に予約済みのすべてのユーザーコードをリストします。
static `SFBAlarmMgrSmp`	NewInstance( `SFCErrorPtr` exception = null ) SFBAlarmMgr インスタンスを生成します。
static `SFBAlarmMgrSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) SFBAlarmMgr インスタンスを生成します。
`SFCError`	ReserveUserCodes( `AEECLSID` clsid , `UInt16Ptr` usercodes , `UInt32Ptr` count ) アプリケーションが実際にアラームを設定する必要なく、指定されたアプリケーションの ClassID の指定された数のアラームコードを予約します。
`SFCError`	ResumeAlarms( `Void` ) コール側が BREW アラームサブシステムの操作を再開できるようにします。
`SFCError`	SetAlarm( `AEECLSID` clsid , `UInt32Ptr` usercode , `UInt32` seconds ) アラームをアプレットに設定できます。
`UInt32`	SetUserCode( `UInt16` usercode , `Bool` provided , `Bool` absolute ) ユーザーコードを設定します。
`SFCError`	SuspendAlarms( `Void` ) コール側が BREW アラームサブシステムの操作を一時停止できるようにします。
`SFCError`	QueryInterface( `AEECLSID` clsid , `VoidHandle` handle ) (SFBQuery から継承) このオブジェクトからの別の API を問い合わせます。
`SFCError`	QueryInterface( `AEECLSID` clsid , `SFBBaseSmpPtr` handle ) (SFBQuery から継承) このオブジェクトからの別の API を問い合わせます。
`SFBBaseSmp`	QueryInterface( `AEECLSID` clsid ) (SFBQuery から継承) このオブジェクトからの別の API を問い合わせます。
`Void`	Self( `AEECLSID` clsidReq , `SFBQuerySmpPtr` clone , `AEECLSID` clsidImp ) (SFBQuery から継承) オブジェクトを単一インターフェースで実装するときに使います。
`SFBQuerySmp`	Self( `AEECLSID` clsidReq , `AEECLSID` clsidImp ) (SFBQuery から継承) オブジェクトを単一インターフェースで実装するときに使います。

プロテクト関数
static `SFBBaseSmp`	FactoryByCreate( `AEECLSID` id , `SFCErrorPtr` exception = null ) (SFBBase から継承) 指定したクラス ID のインターフェースのインスタンスを生成します。
static `SFBBaseSmp`	FactoryByQuery( `SFBQuerySmpConstRef` query , `AEECLSID` id , `SFCErrorPtr` exception = null ) (SFBBase から継承) 指定したクラス ID のインターフェースのインスタンスを指定した SFBQuery インスタンスを使用して生成します。

SFBAlarmMgr::AlarmsActive

この関数に渡された ClassID で指定されたアプリケーション用にアラームが設定されている場合に SUCCESS を返します。 ClassID がゼロの場合、この関数は現在実行中のアプリケーションの結果を返します。 ClassID がゼロ以外であり、現在のアプリケーションでない場合、コール側は AEEGROUPID_ALARM_ALL の特権レベルを持っている必要があります。

[ public ]
SFCError AlarmsActive(
    AEECLSID clsid   // アラームがアクティブであるかをチェックする ClassID
);

戻り値

SUCCESS: 待機中のアラームがある場合。
ENOSUCH: 待機中のアラームがない場合。
EPRIVLEVEL: ユーザーがこの操作の特権レベルを持っていない。
EBADPARM: ClassID が無効。

解説

この関数に渡された ClassID で指定されたアプリケーション用にアラームが設定されている場合に SUCCESS を返します。ClassID がゼロの場合、この関数は現在実行中のアプリケーションの結果を返します。ClassID がゼロ以外であり、現在のアプリケーションでない場合、コール側は AEEGROUPID_ALARM_ALL の特権レベルを持っている必要があります。

参照

BREW API IALARMMGR_AlarmsActive

SFBAlarmMgr::CancelAlarm

SFBALARMMGR::SetAlarm() または SFBSHELL::SetAlarm() で設定されたアラームをキャンセルします。

[ public ]
SFCError CancelAlarm(
    AEECLSID clsid    // キャンセルするアラームのアプレットのクラス
    UInt16 usercode   // キャンセルするアラームの 16 ビットのユーザーコード
);

戻り値

SUCCESS: アラームが検出されてキャンセルされた場合。
EFAILED: アラームを検出またはキャンセルできない場合。
EPRIVLEVEL: ユーザーがこの操作の特権レベルを持っていない。
EBADPARM: ClassID が無効。

解説

SFBALARMMGR::SetAlarm() または SFBSHELL::SetAlarm() で設定されたアラームをキャンセルします。適切なクラスと 16 ビットのユーザーコードを指定する必要があります。 ClassID がゼロの場合、この関数は現在実行中のアプリケーションの結果を返します。 ClassID がゼロ以外であり、現在のアプリケーションでない場合、コール側は AEEGROUPID_ALARM_ALL の特権レベルを持っている必要があります。

参照

BREW API IALARMMGR_CancelAlarm

SFBAlarmMgr::GetUserCode

ユーザーコードを取得します。

[ public ]
UInt16 GetUserCode(
    UInt32 usercode   // ユーザーコード
);

参照

SFBAlarmMgr::SetUserCode

SFBAlarmMgr::IsCodeReserved

指定されたユーザーコードが、コール側アプリケーションによって予約されているかをチェックします。

[ public ]
Bool IsCodeReserved(
    UInt16 usercode   // 予約されているかをチェックするアラームユーザーコード
);

戻り値

TRUE: アラームユーザーコードがアプリケーションによって予約済みの場合。
FALSE: アラームユーザーコードがアプリケーションによって予約済みでない場合。

参照

BREW API IALARMMGR_IsCodeReserved

SFBAlarmMgr::ListAlarmCodes

アプリケーション用に予約済みのすべてのユーザーコードをリストします。

[ public ]
SFCError ListAlarmCodes(
    AEECLSID clsid        // 予約済みのアラームユーザーコードをクエリーまたはリストするクラス
    UInt16Ptr usercodes   // ユーザーコード
    UInt32Ptr count       // ユーザーコードの合計数
);

引数

clsid: 予約済みのアラームユーザーコードをクエリーまたはリストするクラス。
usercodes: 入力時に Null: Count には、出力時に予約済みアラームユーザーコードの数が含まれる。入力時に有効: Count が null 以外の場合 - 予約済みの最大 Count 個のアラームコードを格納して返す。入力時に有効: Count が null の場合 - 予約済みであるかをクエリーするアラームユーザーコード。出力時に値は変わらない。コール側は、最大数の Count アラームユーザーコードを格納するための十分なメモリーを割り当てることに責任がある。メモリーの割り当て解除もコール側の責任。
count: 入力時に Null: UserCode で指定されたアラームユーザーコードが予約済みであるかをクエリーする。入力時に有効: 返すアラームユーザーコードの最大数を指定する。出力時に、UserCode が null の場合は予約済みユーザーコードの合計数が含まれる。

戻り値

SUCCESS: アプリケーション用に予約済みのアラームコードがある場合 (リストモード)、またはクエリーしたアラームユーザーコードが予約済みである場合 (クエリーモード)。
ENOSUCH: アプリケーション用に予約済みのアラームコードがない場合 (リストモード)、またはクエリーしたアラームユーザーコードが予約済みでない場合 (クエリーモード)
EPRIVLEVEL: ユーザーがこの操作の特権レベルを持っていない。

解説

予約済みのユーザーコードをリストする (リストモード)、指定されたユーザーコードが予約済みであるかクエリーする (クエリーモード) の 2 つのモードで動作します。リストモードでは、そのアラームがアクティブか否かに関わらず、アプリケーション用に予約済みのすべてのユーザーコードをリストします。 ClassID がゼロの場合、この関数は現在実行中のアプリケーションの結果を返します。ClassID がゼロ以外であり、現在のアプリケーションでない場合、コール側は AEEGROUPID_ALARM_ALL の特権レベルを持っている必要があります。

参照

BREW API IALARMMGR_ListAlarmCodes

SFBAlarmMgr::NewInstance

SFBAlarmMgr インスタンスを生成します。

[ public, static ]
SFBAlarmMgrSmp NewInstance(
    SFCErrorPtr exception = null   // エラー値
);

[ public, static ]
SFBAlarmMgrSmp NewInstance(
    AEECLSID id                    // クラスID
    SFCErrorPtr exception = null   // エラー値
);

SFBAlarmMgr::ReserveUserCodes

アプリケーションが実際にアラームを設定する必要なく、指定されたアプリケーションの ClassID の指定された数のアラームコードを予約します。

[ public ]
SFCError ReserveUserCodes(
    AEECLSID clsid        // 予約するアラームコードのクラス
    UInt16Ptr usercodes   // ユーザーコード
    UInt32Ptr count       // ユーザーコードの数
);

引数

clsid: 予約するアラームコードのクラス。
usercodes: 関数のリターン時に、生成されたユーザーコードが含まれる。コール側は、nCount 個のユーザーコードを格納するためのメモリーの割り当てに責任がある。メモリーの割り当て解除もコール側の責任。
count: 入力時は、必要なユーザーコードの数を指定する。出力時は、生成して返すユーザーコードの数を指定する。

戻り値

SUCCESS: アラームユーザーコードの予約に成功した場合。
EFAILED: アラームユーザーコードの予約に失敗した場合。
EPRIVLEVEL: ユーザーがこの操作の特権レベルを持っていない。
ENOTALLOWED: アプリケーションが、指定された数のユーザーコードを予約するための特権 (AEEGROUPID_RESERVECODE_LARGE) を持っていない。

解説

アプリケーションが実際にアラームを設定する必要なく、指定されたアプリケーションの ClassID の指定された数のアラームコードを予約します。アプリケーションの未使用のアラームコードは、削除されると開放されます。 ClassID がゼロの場合、この関数は現在実行中のアプリケーションの結果を返します。ClassID がゼロ以外であり、現在のアプリケーションでない場合、コール側は AEEGROUPID_ALARM_ALL の特権レベルを持っている必要があります。アプリケーションで 30 より多くのユーザーコードを予約するには、アプリケーションは AEEGROUPID_RESERVECODE_LARGE 特権レベルを持っている必要があります。

参照

BREW API IALARMMGR_ReserveUserCodes

SFBAlarmMgr::ResumeAlarms

コール側が BREW アラームサブシステムの操作を再開できるようにします。

[ public ]
SFCError ResumeAlarms(Void);

戻り値

SUCCESS: 正常終了の場合
EPRIVLEVEL: 特権が不十分 (AEEGROUPID_ALARM_MGR を持っている必要がある)
その他: 該当する場合は、AEEError

解説

コール側が BREW アラームサブシステムの操作を再開できるようにします。満了時刻を過ぎたすべてのアラームについて通知がスケジュールされます。アラームを再開するには、アプリケーションは AEEGROUPID_ALARM_MGR 特権レベルを持っている必要があります。

参照

BREW API IALARMMGR_ResumeAlarms SFBAlarmMgr::SuspendAlarms

SFBAlarmMgr::SetAlarm

アラームをアプレットに設定できます。

[ public ]
SFCError SetAlarm(
    AEECLSID clsid       // アラーム満了時にコールするアプレットのクラス
    UInt32Ptr usercode   // ユーザーコード
    UInt32 seconds       // アラームを設定する秒数
);

引数

clsid: アラーム満了時にコールするアプレットのクラス。
usercode: API のコール側へまたはコール側から、最上位 2 バイトで返される 16 ビットのアラームユーザーコード格納先へのポインタ。次の 2 バイトは 16 ビットのフラグに使用される。ビット 1 が設定されている場合はユーザーコードがユーザーによって供給されることを示し (そうでなければ、BREW が生成)、ビット 2 が設定されている場合はアラーム秒数が絶対時間であることを示す(そうでなければ、現在からの相対時間）。
seconds: アラームを設定する秒数 (現在からの相対時間または絶対時間)。

戻り値

SUCCESS: 正常終了の場合。
EBADPARM: パラメータが無効。
ENOMEMORY: メモリー不足。
ENORESOURCE: 使用できる空きユーザーコードがない。
EPRIVLEVEL: ユーザーがこの操作の特権レベルを持っていない。

解説

コール側は、(満了までの時間が長い) アラームをアプレットに設定できます。16 ビットのアラームユーザーコードは次のように UserCode で指定します。最初の 2 バイト (MSB) は 16 ビット (uint16) のユーザーコード [in/out] を指定します。次の 2 バイトには 16 ビットのフラグが含まれます。最下位ビットは、ユーザーコードがユーザーによって供給されるか BREW によって生成されるかを指定し、このビットが設定されている場合は、ユーザーコードがユーザーによって供給されることを示します。ユーザーコードが BREW によって生成される場合、コードは UserCode の最初の 2 バイトに含まれて返されます。次の有効ビットは、指定されたアラーム時間が相対値であるか絶対値であるかを指定します。このビットが設定されている場合は、絶対時間が指定されることを示します。アプリケーションはヘルパー関数の SFBAlarmMgr::SetUserCode() と SFBAlarmMgr::GetUserCode() を使用して、ユーザーコード値を設定および取得することができます。アラームが満了になると、アプレットがロードされて、ユーザーパラメータとしての 16 ビットの UserCode と共に EVT_ALARM イベントが渡されます。アラーム発生時にアプレットがアクティブでなかった場合、アプレットはロードされますが EVT_APP_START イベントは送られません。アプレットをアクティブにする場合は、ISHELL_StartApplet() をコールする必要があります。この API を複数回コールすることにより、アプレットに複数のアラームを設定できます。 ClassID がゼロの場合、この関数は現在実行中のアプリケーションの結果を返します。 ClassID がゼロ以外であり、現在のアプリケーションでない場合、コール側は AEEGROUPID_ALARM_ALL の特権レベルを持っている必要があります。 cls パラメータで指定された ClassID がデバイス上で有効でない場合は、EBADPARM が返されます。ユーザーがアラームにユーザーコードを指定し、そのユーザーコードでアクティブになっているアラームが既に存在する場合、既存のアラームがキャンセルされて新しいアラームが開始されます。

参照

BREW API IALARMMGR_SetAlarm

SFBAlarmMgr::SetUserCode

ユーザーコードを設定します。

[ public ]
UInt32 SetUserCode(
    UInt16 usercode   // ユーザーコード
    Bool provided     // ユーザーコードがユーザーによって供給される
    Bool absolute     // アラーム秒数が絶対時間である
);

参照

SFBAlarmMgr::GetUserCode

SFBAlarmMgr::SuspendAlarms

コール側が BREW アラームサブシステムの操作を一時停止できるようにします。

[ public ]
SFCError SuspendAlarms(Void);

戻り値

SUCCESS: 正常終了の場合
EPRIVLEVEL: 特権が不十分 (AEEGROUPID_ALARM_MGR を持っている必要がある)
その他: 該当する場合は、AEEError

解説

コール側が BREW アラームサブシステムの操作を一時停止できるようにします。この関数は、アラームをスケジュールするアプリケーションの機能には影響を与えません。単に、SFBAlarmMgr::ResumeAlarms() がコールされるまで、または電話がリセットされるまでアラーム通知を延期するだけです。アラームを一時停止するには、アプリケーションは AEEGROUPID_ALARM_MGR 特権レベルを持っている必要があります。

参照

BREW API IALARMMGR_SuspendAlarms SFBAlarmMgr::ResumeAlarms