前のページ次のページ上に戻るホーム SophiaFramework UNIVERSE 5.3
SFBShell
IShell インターフェースのラッパークラスです。
#include <SFBShell.h.hpp>
class SFBShell : public SFBBase;
SFMTYPEDEFWRAPPER(SFBShell)

継承図

SFBShell クラスの継承図

バージョン

BREW 2.0 BREW 2.1 BREW 3.1 BREW 4.0

参照

BREW API IShell

メンバ

パブリック関数
AEECLSID ActiveApplet( Void )
アクティブなアプリに関連付けられた ClassID を取得します。
Bool AlarmsActive( Void )
待機中のアラームがあるかどうかを取得します。
SFCError AppIsInGroup( AEECLSID idApp , AEECLSID idGroup )
指定されたアプリが指定された特権レベルをサポートしているかを判定します。
Bool Beep( BeepType beep , Bool loud = false )
システムビープ音を鳴らします(または、デバイスを振動させます)。
Void BrowseFile( ACharConstPtr file )
指定されたファイル拡張子に関連付けられているアプリを起動します。
Void BrowseFile( SFXAnsiStringConstRef file )
指定されたファイル拡張子に関連付けられているアプリを起動します。
Void BrowseURL( ACharConstPtr url )
指定された URL 文字列に関連付けられているアプリを起動します。
Void BrowseURL( SFXAnsiStringConstRef url )
指定された URL 文字列に関連付けられているアプリを起動します。
Bool Busy( Void )
アプリの終了が必要かどうかを判定します。
Bool CanStartApplet( AEECLSID clsid )
指定されたアプリが起動できるかどうかを判定します。
SFCError CancelAlarm( AEECLSID clsid , UInt16 userCode )
指定されたアプリに設定されているアラームをキャンセルします。
SFCError CancelTimer( PFNNOTIFY notify = null , VoidPtr data = null )
指定されたコールバック関数とユーザーデータに設定されているタイマーをキャンセルします。
Bool CheckPrivLevel( AEECLSID privilege , Bool queryOnly = true )
現在実行しているアプリの特権レベルを指定された値と照合します。
SFCError ClearProperty( AEECLSID clsid , UInt16 wId )
指定された Class ID に関連付けられている基本モジュールのプロパティをクリアします。
SFCError ClearShutdownErrors( Void )
すべてのアプリのエラー状態をクリアにします。
SFCError CloseApplet( Bool returnToIdle = false )
アクティブなアプリを閉じます。
SFCError CreateDialog( ACharConstPtr resFile , UInt16 id )
ダイアログを起動します。
SFCError CreateDialog( DialogInfo* info )
ダイアログを起動します。
SFCError CreateDialog( SFXAnsiStringConstRef resFile , UInt16 id )
ダイアログを起動します。
SFCError CreateInstance( AEECLSID clsid , SFBBaseSmpPtr handle )
指定された ClassID のオブジェクトを作成します。
SFBBaseSmp CreateInstance( AEECLSID clsid )
指定された ClassID のオブジェクトを作成します。
SFCError DetectType( VoidConstPtr data , UInt32Ptr size , ACharConstPtr name , ACharConstHandle mime )
指定されたバッファデータまたはオブジェクトの MIME タイプを取得します。
SFCError DetectType( SFXBufferConstRef data , UInt32Ptr additional , ACharConstPtr name , ACharConstHandle mime )
指定されたバッファデータまたはオブジェクトの MIME タイプを取得します。
SFCError DetectType( VoidConstPtr data , UInt32Ptr size , SFXAnsiStringConstRef name , SFXAnsiStringPtr mime )
指定されたバッファデータまたはオブジェクトの MIME タイプを取得します。
SFCError DetectType( SFXBufferConstRef data , UInt32Ptr additional , SFXAnsiStringConstRef name , SFXAnsiStringPtr mime )
指定されたバッファデータまたはオブジェクトの MIME タイプを取得します。
SFCError DetectType( VoidConstPtr data , UInt32Ptr size , SFXAnsiStringPtr mime )
指定されたバッファデータまたはオブジェクトの MIME タイプを取得します。
SFCError DetectType( SFXBufferConstRef data , UInt32Ptr additional , SFXAnsiStringPtr mime )
指定されたバッファデータまたはオブジェクトの MIME タイプを取得します。
SFCError EndDialog( Void )
現在アクティブなダイアログを閉じます。
Void EnumAppletInit( Void )
AEE シェルの内部アプリの列挙インデックスをリセットします。
AEECLSID EnumNextApplet( AEEAppInfo* info )
次のアプリに関する情報を取得します。
Bool ForceExit( Void )
アプリの終了が必要かどうかを判定します。
Void FreeResData( VoidPtr data )
リソースファイルからロードしたデータブロックを解放します。
SFBDialogSmp GetActiveDialog( Void )
現在アクティブなダイアログを取得します。
SInt32 GetAppAuthor( WCharPtr buf , SInt32 size )
アクティブなアプリの作成者の名前を取得します。
SInt32 GetAppAuthor( SFXWideStringPtr string )
アクティブなアプリの作成者の名前を取得します。
SInt32 GetAppCopyright( WCharPtr buf , SInt32 size )
アクティブなアプリの著作権文字列を取得します。
SInt32 GetAppCopyright( SFXWideStringPtr string )
アクティブなアプリの著作権文字列を取得します。
SInt32 GetAppPrefs( UInt16 version , VoidPtr buf , UInt16 size )
アプリのプリファレンスが含まれる構造体を取得します。
SInt32 GetAppPrefs( UInt16 version , SFXBufferPtr buf )
アプリのプリファレンスが含まれる構造体を取得します。
SInt32 GetAppVersion( WCharPtr buf , SInt32 size )
アクティブなアプリのバージョン文字列を取得します。
SInt32 GetAppVersion( SFXWideStringPtr string )
アクティブなアプリのバージョン文字列を取得します。
UInt32 GetClassItemID( AEECLSID clsid )
指定された ClassID を所有しているモジュールに割り当てられた 32 ビット値を取得します。
Void GetDeviceInfo( AEEDeviceInfo* info )
デバイス情報を AEE シェルから取得します。
SFCError GetDeviceInfoEx( AEEDeviceItem item , VoidPtr info , SInt32Ptr size )
指定されたデバイス項目 ID に関する情報を取得します。
SFCError GetDeviceInfoEx( AEEDeviceItem item , SFXBufferPtr info )
指定されたデバイス項目 ID に関する情報を取得します。
AEECLSID GetHandler( AEECLSID type , ACharConstPtr in )
コンテンツビューアおよびプロトコル方式のハンドラを AEE シェルから取得します。
AEECLSID GetHandler( AEECLSID type , SFXAnsiStringConstRef in )
コンテンツビューアおよびプロトコル方式のハンドラを AEE シェルから取得します。
static
SFBShellSmp
GetInstance( Void )
SFBShell インスタンスを取得します。
Void GetItemStyle( AEEItemType type , AEEItemStyle* normal , AEEItemStyle* selected )
メニュー、アイコン、またはリスト項目のデフォルトスタイルに関する情報を AEE シェルから取得します。
Void GetJulianDate( UInt32 seconds , JulianType* date )
指定された秒数に基づいて JulianType データ構造体を取得します。
SInt32 GetPrefs( AEECLSID clsid , UInt16 version , VoidPtr config , UInt16 size )
指定された ClassID のアプリまたはクラスのレベルプリファレンスが含まれる構造体を取得します。
SInt32 GetPrefs( AEECLSID clsid , UInt16 version , SFXBufferPtr config )
指定された ClassID のアプリまたはクラスのレベルプリファレンスが含まれる構造体を取得します。
SFCError GetProperty( AEECLSID clsid , UInt16 wId , VoidPtr dest , UInt16Ptr size )
入力クラスに関連付けられている基本モジュールのプロパティデータを取得します。
SFCError GetProperty( AEECLSID clsid , UInt16 wId , SFXBufferPtr dest )
入力クラスに関連付けられている基本モジュールのプロパティデータを取得します。
UInt32 GetResSize( ACharConstPtr file , UInt16 id , ResType type , UInt32Ptr size )
指定されたリソースファイルから指定されたタイプと ID のリソースをロードします。
UInt32 GetResSize( SFXAnsiStringConstRef file , UInt16 id , ResType type , UInt32Ptr size )
指定されたリソースファイルから指定されたタイプと ID のリソースをロードします。
UInt32 GetTimeMS( Void )
現在の時刻を取得します。[単位: ミリ秒]
UInt32 GetTimerExpiration( PFNNOTIFY notify , VoidPtr data = null )
指定されたデバイスのユーザーコールバックまたはユーザーデータに関連付けられたタイマーが満了するまでの残存時間をで取得します。[単位: ミリ秒]
UInt32 GetUpTimeMS( Void )
デバイスに電源が投入されてからの経過時間を取得します。[単位: ミリ秒]
Bool HandleEvent( AEEEvent event , UInt16 wParam , UInt32 dwParam )
指定された標準 AEE イベントを現在アクティブなアプリに送信します。
Bool HandleEvent( SFXEventConstRef event )
指定された標準 AEE イベントを現在アクティブなアプリに送信します。
Bool IsValidResource( ACharConstPtr file , UInt16 id , ResType resType , AEEHandlerType handlerType )
指定されたリソースファイルのエントリが、 指定されたタイプについて有効かどうかを判定します。
Bool IsValidResource( SFXAnsiStringConstRef file , UInt16 id , ResType resType , AEEHandlerType handlerType )
指定されたリソースファイルのエントリが、 指定されたタイプについて有効かどうかを判定します。
SFBBitmapSmp LoadBitmap( ACharConstPtr file )
指定されたファイルからビットマップを直接ロードします。
SFBBitmapSmp LoadBitmap( SFXAnsiStringConstRef file )
指定されたファイルからビットマップを直接ロードします。
SFBImageSmp LoadBusyImage( Void )
BREW がビジーであることを示すために使われる画像をロードします。
SFBImageSmp LoadImage( ACharConstPtr file )
指定されたファイルからイメージデータを直接ロードします。
SFBImageSmp LoadImage( SFXAnsiStringConstRef file )
指定されたファイルからイメージデータを直接ロードします。
SFBBitmapSmp LoadResBitmap( ACharConstPtr resFile , UInt16 id )
指定されたリソースファイル内の指定されたリソース ID のビットマップをロードします。
SFBBitmapSmp LoadResBitmap( SFXAnsiStringConstRef resFile , UInt16 id )
指定されたリソースファイル内の指定されたリソース ID のビットマップをロードします。
VoidPtr LoadResData( ACharConstPtr resFile , UInt16 id , ResType type )
指定されたリソースファイル内の指定されたリソース ID、リソースタイプのデータブロックをロードします。
VoidPtr LoadResData( SFXAnsiStringConstRef resFile , UInt16 id , ResType type )
指定されたリソースファイル内の指定されたリソース ID、リソースタイプのデータブロックをロードします。
VoidPtr LoadResDataEx( ACharConstPtr resFile , UInt16 id , ResType type , VoidPtr buf , UInt32Ptr size )
指定されたリソースファイル内の指定されたリソース ID、リソースタイプのデータブロックをロードします (データは buf 引数に指定したバッファに格納されます)。
VoidPtr LoadResDataEx( SFXAnsiStringConstRef resFile , UInt16 id , ResType type , VoidPtr buf , UInt32Ptr size )
指定されたリソースファイル内の指定されたリソース ID、リソースタイプのデータブロックをロードします (データは buf 引数に指定したバッファに格納されます)。
VoidPtr LoadResDataEx( SFXAnsiStringConstRef resFile , UInt16 id , ResType type , SFXBufferPtr buf )
指定されたリソースファイル内の指定されたリソース ID、リソースタイプのデータブロックをロードします (データは buf 引数に指定したバッファに格納されます)。
SFBImageSmp LoadResImage( ACharConstPtr resFile , UInt16 id )
指定されたリソースファイル内の指定されたリソース ID のイメージをロードします。
SFBImageSmp LoadResImage( SFXAnsiStringConstRef resFile , UInt16 id )
指定されたリソースファイル内の指定されたリソース ID のイメージをロードします。
SFBBaseSmp LoadResObject( ACharConstPtr resFile , UInt16 id , AEECLSID clsidBase )
指定されたリソースファイル内の指定されたリソース ID、リソースタイプのオブジェクトをロードします。
SFBBaseSmp LoadResObject( SFXAnsiStringConstRef resFile , UInt16 id , AEECLSID clsidBase )
指定されたリソースファイル内の指定されたリソース ID、リソースタイプのオブジェクトをロードします。
SFBSoundPlayerSmp LoadResSound( ACharConstPtr resFile , UInt16 id )
指定されたリソースファイル内の指定されたリソース ID の音声データをロードします。
SFBSoundPlayerSmp LoadResSound( SFXAnsiStringConstRef resFile , UInt16 id )
指定されたリソースファイル内の指定されたリソース ID の音声データをロードします。
SInt32 LoadResString( ACharConstPtr resFile , UInt16 id , WCharPtr buf , SInt32 size )
指定されたリソースファイル内の指定されたリソース ID の UNICODE または ISOLATIN 文字列をロードします (文字列は buf 引数に指定したバッファに格納されます)。
SFXWideString LoadResString( SFXAnsiStringConstRef resFile , UInt16 id )
指定されたリソースファイル内の指定されたリソース ID の UNICODE または ISOLATIN 文字列をロードします (文字列は buf 引数に指定したバッファに格納されます)。
SInt32 LoadResString( ACharConstPtr resFile , UInt16 id , SFXWideStringPtr string )
指定されたリソースファイル内の指定されたリソース ID の UNICODE または ISOLATIN 文字列をロードします (文字列は buf 引数に指定したバッファに格納されます)。
SInt32 LoadResString( SFXAnsiStringConstRef resFile , UInt16 id , SFXWideStringPtr string )
指定されたリソースファイル内の指定されたリソース ID の UNICODE または ISOLATIN 文字列をロードします (文字列は buf 引数に指定したバッファに格納されます)。
SFBSoundPlayerSmp LoadSound( ACharConstPtr resFile )
指定されたファイルからサウンドデータをロードします。
SFBSoundPlayerSmp LoadSound( SFXAnsiStringConstRef resFile )
指定されたファイルからサウンドデータをロードします。
Bool MessageBox( ACharConstPtr resFile , UInt16 titleId , UInt16 textId )
指定されたリソースファイルから指定された ID のタイトルとテキストを取得し、 メッセージボックスを作成して表示します。
Bool MessageBox( SFXAnsiStringConstRef resFile , UInt16 titleId , UInt16 textId )
指定されたリソースファイルから指定された ID のタイトルとテキストを取得し、 メッセージボックスを作成して表示します。
Bool MessageBoxText( WCharConstPtr title , WCharConstPtr text )
指定されたタイトル文字列とテキスト文字列からメッセージボックスを作成し表示します。
Bool MessageBoxText( SFXWideStringConstRef title , SFXWideStringConstRef text )
指定されたタイトル文字列とテキスト文字列からメッセージボックスを作成し表示します。
SFCError Notify( AEECLSID clsid , UInt32 mask , VoidPtr data )
指定されたアプリに指定されたイベントが発生したことを通知します。
Void OnAppClose( SFXCallbackPtr callback )
アプリ終了時に呼び出されるコールバックを登録します。
Void OnExit( SFXCallbackPtr callback )
BREW 終了時に呼び出されるコールバックを登録します。
Void OnInit( SFXCallbackPtr callback )
BREW 初期化時に呼び出されるコールバックを登録します。
Void OnLowRAM( SFXCallbackPtr callback )
システムのメモリが少量になったときに呼び出されるコールバックを登録します。
Void OnLowRAMCritical( SFXCallbackPtr callback )
システムメモリが少なくなり、AEE_SCB_LOW_RAM コールバックによっても充分なメモリを確保できない場合に呼び出されるコールバックを登録します。
Void OnLowStorage( SFXCallbackPtr callback )
ファイルシステム容量が少量になったときに呼び出されるコールバックを登録します。
Void OnModUnload( SFXCallbackPtr callback )
モジュールがアンロードされる直前に呼び出されるコールバックを登録します。
Bool PostEvent( AEECLSID clsid , AEEEvent event , UInt16 wValue , UInt32 dwValue )
指定されたアプリに指定された非同期イベントをポストします。
Bool PostEvent( AEECLSID clsid , SFXEventConstRef event )
指定されたアプリに指定された非同期イベントをポストします。
Bool PostEventEx( UInt16 flags , AEECLSID clsid , AEEEvent event , UInt16 wValue , UInt32 dwValue )
指定されたアプリに指定された非同期イベントをポストします。
Bool PostEventEx( UInt16 flags , AEECLSID clsid , SFXEventConstRef event )
指定されたアプリに指定された非同期イベントをポストします。
Bool PostURL( ACharConstPtr url )
URL のスキームに関連付けられたアプリに対し、非同期のイベントとして EVT_APP_POST_URL イベントをポストします。
Bool Prompt( AEEPromptInfo* info )
マルチ選択のプロンプトを表示します。
Bool QueryClass( AEECLSID clsid , AEEAppInfo* info )
指定された ClassID のクラスまたはアプリがサポートされているかどうかを判定します。
AEEEvent RegisterEvent( ACharConstPtr name , SInt32Ptr count )
指定されたイベント名を基に他のユーザーイベントと競合しないイベントを登録します。
AEEEvent RegisterEvent( SFXAnsiStringConstRef name , SInt32Ptr count )
指定されたイベント名を基に他のユーザーイベントと競合しないイベントを登録します。
SFCError RegisterHandler( AEECLSID clsidBase , ACharConstPtr in , AEECLSID clsid )
指定されたハンドラを AEE シェルに登録します。
SFCError RegisterHandler( AEECLSID clsidBase , SFXAnsiStringConstRef in , AEECLSID clsid )
指定されたハンドラを AEE シェルに登録します。
SFCError RegisterNotify( AEECLSID clsidNotify , AEECLSID clsidType , UInt32 mask )
他のクラスから発行される通知を登録します。
Void RegisterSystemCallback( SFXCallbackPtr callback , SInt32 type )
システムイベントに対するコールバックを登録します。
SFCError Reset( AEEResetType type )
デバイスをリセットします。
Void Resume( SFXCallbackPtr callback )
AEE シェルにコールバックを登録します。
SFCError ResumeAlarms( Void )
BREW アラーム機能を再開します。
Bool SendEvent( AEECLSID clsid , AEEEvent event , UInt16 wParam , UInt32 dwParam )
指定されたアプリ(またはダイアログ)に指定された同期イベントを送信します。
Bool SendEvent( AEECLSID clsid , SFXEventConstRef event )
指定されたアプリ(またはダイアログ)に指定された同期イベントを送信します。
Bool SendURL( ACharConstPtr url )
URL のスキームに関連付けられたアプリに対し、同期のイベントとして EVT_APP_POST_URL イベントを送ります。
Bool SendURL( SFXAnsiStringConstRef url )
URL のスキームに関連付けられたアプリに対し、同期のイベントとして EVT_APP_POST_URL イベントを送ります。
SFCError SetAlarm( AEECLSID clsid , UInt16 code , UInt32 minutes )
アラームをアプリに設定します。
SFCError SetAppPrefs( UInt16 version , VoidPtr config , UInt16 size )
指定されたアプリ固有のプリファレンスが含まれる構造体を設定します。
SFCError SetAppPrefs( UInt16 version , SFXBufferPtr config )
指定されたアプリ固有のプリファレンスが含まれる構造体を設定します。
SFCError SetPrefs( AEECLSID clsid , UInt16 version , VoidPtr config , UInt16 size )
指定されたアプリ固有のプリファレンスを設定します。
SFCError SetPrefs( AEECLSID clsid , UInt16 version , SFXBufferPtr config )
指定されたアプリ固有のプリファレンスを設定します。
SFCError SetProperty( AEECLSID clsid , UInt16 wId , VoidPtr src , UInt16 size )
指定された Class ID に関連付けられている基本モジュールのプロパティを設定します。
SFCError SetProperty( AEECLSID clsid , UInt16 wId , SFXBufferPtr src )
指定された Class ID に関連付けられている基本モジュールのプロパティを設定します。
SFCError SetTimer( SInt32 mSecs , PFNNOTIFY notify , VoidPtr data = null )
タイマーを設定します。[単位: ミリ秒]
SFCError SetTimerEx( SInt32 mSecs , SFXCallbackPtr callback )
コールバック構造体を使用してタイマーを設定します。 [単位: ミリ秒]
Bool ShowCopyright( Void )
アプリの著作権情報を表示します。
SFCError StartApplet( AEECLSID clsid )
指定されたアプリをフォアグラウンドで起動します。
SFCError StartAppletArgs( AEECLSID clsid , ACharConstPtr args )
指定されたアプリを起動し、コマンドライン引数を渡します。
SFCError StartAppletArgs( AEECLSID clsid , SFXAnsiStringConstRef args )
指定されたアプリを起動し、コマンドライン引数を渡します。
SFCError StartAppletEx( AEECLSID clsid , UInt16 flags )
指定されたフラグの内容で指定されたアプリをフォアグラウンドで起動します。
SFCError StartBackgroundApplet( AEECLSID clsid , ACharConstPtr args )
指定されたアプリをバックグラウンドで起動します。
SFCError StartBackgroundApplet( AEECLSID clsid , SFXAnsiStringConstRef args )
指定されたアプリをバックグラウンドで起動します。
SFCError SuspendAlarms( Void )
BREW アラーム機能を一時停止します。
SFCError UnregisterHandler( SFXAnsiStringConstRef in )
ハンドラの登録を解除します。
プロテクト関数
static
SFBBaseSmp
FactoryByCreate( AEECLSID id , SFCErrorPtr exception = null ) (SFBBase から継承)
指定したクラス ID のインターフェースのインスタンスを生成します。
static
SFBBaseSmp
FactoryByQuery( SFBQuerySmpConstRef query , AEECLSID id , SFCErrorPtr exception = null ) (SFBBase から継承)
指定したクラス ID のインターフェースのインスタンスを指定した SFBQuery インスタンスを使用して生成します。

SFBShell::ActiveApplet
アクティブなアプリに関連付けられた ClassID を取得します。
[ public ]
AEECLSID ActiveApplet(Void);

戻り値

アクティブなアプリに関連付けられた ClassID。

アクティブなアプリが存在しない場合、0。

解説

この関数は、アクティブなアプリに関連付けられた ClassID を取得します。

[Note] 注意

アクティブなアプリとは、 現在実行中のアプリの中で最前面に配置され可視状態にあるアプリのことです。

参照

BREW API ISHELL_ActiveApplet | AEECLSID | SFBShell::StartApplet | SFBShell::CloseApplet | SFBShell::CanStartApplet


SFBShell::AlarmsActive
待機中のアラームがあるかどうかを取得します。
[ public ]
Bool AlarmsActive(Void);

戻り値

  • 待機中のアラームがあるとき: true
  • そうでないとき: false

解説

この関数は、待機中のアラームがあるかどうかを取得します。

アナンシエータ(呼び出し表示装置)に ANNUN_ALARMCLOCK、ANNUN_COUNTDOWN、または ANNUN_STOPWATCH が設定されている場合は、true を返します。

参照

BREW API ISHELL_AlarmsActive | SFBDisplay::SetAnnunciators


SFBShell::AppIsInGroup
指定されたアプリが指定された特権レベルをサポートしているかを判定します。
[ public ]
SFCError AppIsInGroup(
    AEECLSID idApp     // アプリの ClassID
    AEECLSID idGroup   // グループ ID
);

戻り値

  • 指定したアプリが指定した特権レベルをサポートしているとき: SFERR_NO_ERROR
  • idApp 引数に指定した ClassID がアプリの ClassID でないとき: SFERR_CLASS_UNSUPPORTED
  • 指定したアプリが指定した特権レベルをサポートしていないとき: EPRIVLEVEL

解説

この関数は、 指定されたアプリが指定された特権レベルをサポートしているかを判定します。

[Note] 注意

idGroup 引数の上位ワードが 0 の場合、 idGroup 引数は以下の旧スタイルの特権ビットのビットマスクとして処理されます。

  • PL_FILE
  • PL_NETWORK
  • PL_TAPI
  • PL_DOWNLOAD
  • PL_SHARED_WRITE
  • PL_POS_LOCATION
  • PL_SYSTEM
  • PL_WEB
  • PL_RINGER_WRITE
  • PL_SECTORINFO
  • PL_ADDRBOOK

バージョン

[Note] 注意

この関数は、BREW 3.1 から使用可能です。

参照

BREW API ISHELL_AppIsInGroup | BREW API AEE特権レベル | AEECLSID | SFBShell::CheckPrivLevel


SFBShell::Beep
システムビープ音を鳴らします(または、デバイスを振動させます)。
[ public ]
Bool Beep(
    BeepType beep       // ビープ音タイプ
    Bool loud = false   // 高い音量でシステムビープ音を鳴らす場合は、true を指定します。
);

戻り値

  • システムビープ音を鳴らしたとき(デバイスを振動させたとき): true
  • そうでないとき: false

解説

この関数は、 システムビープ音を鳴らします(または、デバイスを振動させます)。

beep 引数には、 BeepType 列挙型の値を指定します。

[Note] 注意

BREW シミュレータの場合、 開発者は独自のビープ音タイプ(BeepType)のトーンを WAV 形式で定義できます。

このトーンは、 <$BREWDIR\bin\DataFiles> ディレクトリに保存されます。

たとえば、独自の BEEP_ALERTトーンを作成するには、 BEEP_ALERT.wavという名前でWAV形式ファイルを保存します。

参照

BREW API ISHELL_Beep | BeepType


SFBShell::BrowseFile
指定されたファイル拡張子に関連付けられているアプリを起動します。
[ public ]
Void BrowseFile(
    ACharConstPtr file   // ファイル名
);
[ public ]
Void BrowseFile(
    SFXAnsiStringConstRef file   // ファイル名
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • 他のアプリが既に起動しているとき: EALREADY
  • シェルクラスが無効なとき: EBADCLASS
  • メモリ不足のとき: SFERR_NO_MEMORY
  • 指定したクラスがサポートされていないとき: SFERR_CLASS_UNSUPPORTED
  • アプリの有効期限が過ぎているとき: EEXPIRED

解説

この関数は、 指定されたファイル拡張子に関連付けられているアプリを起動します。

起動されたアプリは、EVT_BROWSE_FILE イベントを受信します。

[Note] 注意

起動動作は、SFBShell::StartApplet 関数とまったく同じです。

参照

BREW API ISHELL_BrowseFile | SFBShell::StartApplet | SFBShell::StartAppletEx | SFBShell::BrowseURL


SFBShell::BrowseURL
指定された URL 文字列に関連付けられているアプリを起動します。
[ public ]
Void BrowseURL(
    ACharConstPtr url   // URL
);
[ public ]
Void BrowseURL(
    SFXAnsiStringConstRef url   // URL
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • 他のアプリが既に起動しているとき: EALREADY
  • シェルクラスが無効なとき: EBADCLASS
  • メモリ不足のとき: SFERR_NO_MEMORY
  • 指定したクラスがサポートされていないとき: SFERR_CLASS_UNSUPPORTED
  • アプリの有効期限が過ぎているとき: EEXPIRED

解説

この関数は、 指定された URL 文字列に関連付けられているアプリを起動します。

起動されたアプリは、EVT_BROWSE_URL イベントを受信します。

[Note] 注意

起動動作は、SFBShell::StartApplet 関数とまったく同じです。

参照

BREW API ISHELL_BrowseURL | SFBShell::StartApplet | SFBShell::StartAppletEx | SFBShell::BrowseFile


SFBShell::Busy
アプリの終了が必要かどうかを判定します。
[ public ]
Bool Busy(Void);

戻り値

  • アプリが処理を中止して終了する必要があるとき: true
  • アプリが処理を継続できるとき: false

解説

この関数は、 アプリの終了が必要かどうかを判定します。

[Note] 注意

この関数は、ブラウザなどイベントループ(SFBShell::HandleEvent 関数) から戻るまでにたくさんの処理を行う必要のあるアプリで使用します。

この関数は、内部で SFBShell::ForceExit 関数を使用しています。

参照

BREW API ISHELL_Busy | SFBShell::HandleEvent | SFBShell::ForceExit


SFBShell::CanStartApplet
指定されたアプリが起動できるかどうかを判定します。
[ public ]
Bool CanStartApplet(
    AEECLSID clsid   // アプリの ClassID
);

戻り値

  • 指定したアプリが起動できるとき: true
  • そうでないとき: false

解説

この関数は、 指定されたアプリが起動できるかどうかを判定します。

[Note] 注意

通常、この関数は true を返します。

ただし、重要なダイアログが表示されている場合や他のアプリが実行中の場合は、 新しいアプリの起動が制限されることもあります。

参照

BREW API ISHELL_CanStartApplet | AEECLSID | SFBShell::StartApplet | SFBShell::CloseApplet | SFBShell::ActiveApplet


SFBShell::CancelAlarm
指定されたアプリに設定されているアラームをキャンセルします。
[ public ]
SFCError CancelAlarm(
    AEECLSID clsid    // キャンセルするアラームが設定されているアプリの ClassID
    UInt16 userCode   // キャンセルするアラームの 16 ビット値
);

戻り値

  • アラームが検出されてキャンセルされたとき: SFERR_NO_ERROR
  • アラームを検出またはキャンセルできないとき: SFERR_FAILED

解説

この関数は、 指定されたアプリに設定されているアラームをキャンセルします。

[Note] 注意

引数に適正な ClassID と 16 ビットのユーザーコードを指定しなかった場合は、 SFERR_FAILED が返ります。

参照

BREW API ISHELL_CancelAlarm | AEECLSID | SFBShell::SetAlarm | SFBShell::SuspendAlarms | SFBShell::ResumeAlarms


SFBShell::CancelTimer
指定されたコールバック関数とユーザーデータに設定されているタイマーをキャンセルします。
[ public ]
SFCError CancelTimer(
    PFNNOTIFY notify = null   // コールバック関数
    VoidPtr data = null       // ユーザーデータ
);

戻り値

常に SFERR_NO_ERROR。

解説

この関数は、 指定されたコールバック関数とユーザーデータに設定されているタイマーをキャンセルします。

[Note] 注意

notify 引数が null である場合、 data 引数に関連付けられたすべてのタイマーがキャンセルされます。

設定されていないタイマーをキャンセルしても問題はありません。

使用例

設定中のタイマーをキャンセルします。

SFBShellSmp     shell = SFBShell::GetInstance();

// 設定中のタイマーをキャンセルする
shell->CancelTimer(OnTimerEntry, this);

参照

BREW API ISHELL_CancelTimer | PFNNOTIFY | SFBShell::SetTimer | SFBShell::SetTimerEx | SFBShell::GetTimerExpiration


SFBShell::CheckPrivLevel
現在実行しているアプリの特権レベルを指定された値と照合します。
[ public ]
Bool CheckPrivLevel(
    AEECLSID privilege      // 特権レベルの ClassID または 特権ビットのビットマスク
    Bool queryOnly = true   // 問い合わせのみの場合は true、特権が無い場合にアプリを終了させる場合は false を指定する
);

戻り値

  • 指定した特権レベルをサポートしているとき: true
  • そうでないとき: false

解説

この関数は、 現在実行しているアプリの特権レベルを指定された値と照合します。

特権レベルがサポートされる場合は true、されない場合は false を返します。 queryOnly 引数が false で特権レベルがサポートされていない場合は、 システムメッセージを出力してアプリを終了します。

privilege 引数の高位ワードが 0 の場合、privilege 引数は以下の特権ビットのビットマスクとして処理されます。

  • PL_FILE
  • PL_NETWORK
  • PL_TAPI
  • PL_DOWNLOAD
  • PL_SHARED_WRITE
  • PL_POS_LOCATION
  • PL_SYSTEM
  • PL_WEB
  • PL_RINGER_WRITE
  • PL_SECTORINFO
  • PL_ADDRBOOK

アプリは、以下の 3 つのいずれかの方法で「グループ」のメンバになります。

  1. 各アプリは、アプリの ClassID のグループのメンバです。
  2. MIF の各特権レベルは、PL_FILE や PL_NETWORK などのグループを表します。
  3. MIF の「依存ファイル」に ClassID を追加することにより、その ClassID が表すグループに追加されます。

各アプリは、グループ 0 のメンバです。

[Caution] 注意

この関数の戻り値が true であっても、 SFBShell::CreateInstance 関数が成功するとは限りません。

指定した ClassID がデバイス上に存在しない、インスタンス化できない(例: PL_FILE)、 または制限されている(アプリの ClassID はシステムだけがインスタンス化できる)場合があるからです。

使用例

ファイルにアクセスできるか確認します。

Bool            ok    = false;
SFBShellSmp     shell = SFBShell::GetInstance();

// アプリの特権レベルを確認する
// ファイルにアクセスできるか確認する
ok = shell->CheckPrivLevel(PL_FILE, true);

参照

BREW API ISHELL_CheckPrivLevel | BREW API AEE特権レベル | SFBShell::AppIsInGroup | SFBShell::CreateInstance | AEECLSID


SFBShell::ClearProperty
指定された Class ID に関連付けられている基本モジュールのプロパティをクリアします。
[ public ]
SFCError ClearProperty(
    AEECLSID clsid   // Class ID
    UInt16 wId       // プロパティ ID
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • メモリ不足のとき: SFERR_NO_MEMORY
  • 指定された Class ID が存在しないとき: EBADCLASS
  • 特権がないとき: EPRIVLEVEL

解説

この関数は、 指定された Class ID に関連付けられている基本モジュールのプロパティをクリアします。

この関数の呼び出しは、 SFBShell::SetProperty(clsid, wId, null, 0); を呼び出すことと同じです。

バージョン

この関数は、BREW 3.1 から使用可能です。

参照

AEECLSID | SFBShell::SetProperty


SFBShell::ClearShutdownErrors
すべてのアプリのエラー状態をクリアにします。
[ public ]
SFCError ClearShutdow(Void);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • 失敗したとき: SFERR_NO_MEMORY
  • 特権がないとき: EPRIVLEVEL

解説

この関数は、 すべてのアプリのエラー状態をクリアにします。

バージョン

この関数は、BREW 3.0 のみ使用可能です。

参照

SFBShell::StartApplet | SFBShell::StartAppletEx


SFBShell::CloseApplet
アクティブなアプリを閉じます。
[ public ]
SFCError CloseApplet(
    Bool returnToIdle = false   // true を指定した場合、アプリを閉じてアイドル画面に戻る
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • 失敗したとき: SFERR_FAILED
  • 特権がないとき: EPRIVLEVEL

解説

この関数は、 アクティブなアプリを閉じます。

アクティブなアプリに対しEVT_APP_STOP イベントが送信されます。

使用例

アプリを閉じます。

SFBShellSmp     shell = SFBShell::GetInstance();

// アプリを閉じる
shell->CloseApplet(false);

参照

BREW API ISHELL_CloseApplet | SFBShell::StartApplet | SFBShell::CanStartApplet | SFBShell::ActiveApplet


SFBShell::CreateDialog
ダイアログを起動します。
[ public ]
SFCError CreateDialog(
    ACharConstPtr resFile   // リソースファイル
    UInt16 id               // リソース ID
);
[ public ]
SFCError CreateDialog(
    DialogInfo* info   // ダイアログ情報の代わりとなる構造体
);
[ public ]
SFCError CreateDialog(
    SFXAnsiStringConstRef resFile   // リソースファイル
    UInt16 id                       // リソース ID
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • メモリ不足のとき: SFERR_NO_MEMORY
  • 引数が不正なとき: SFERR_INVALID_PARAM
  • 失敗したとき: SFERR_FAILED

解説

この関数は、 指定された DialogInfo データ構造に関連するダイアログ、 または指定されたリソースファイルに関連するダイアログを起動します。

参照

BREW API ISHELL_CreateDialog | DialogInfo | SFBShell::GetActiveDialog | SFBShell::EndDialog | SFBDialog::SetFocus | SFBDialog::GetControl


SFBShell::CreateInstance
指定された ClassID のオブジェクトを作成します。
[ public ]
SFCError CreateInstance(
    AEECLSID clsid         // 作成するオブジェクトの ClassID
    SFBBaseSmpPtr handle   // 作成されたオブジェクト
);
[ public ]
SFBBaseSmp CreateInstance(
    AEECLSID clsid   // 作成するオブジェクトの ClassID
);

戻り値

戻り値が SFCError 型の場合:

  • 成功したとき: SFERR_NO_ERROR
  • メモリ不足のとき: SFERR_NO_MEMORY
  • 指定したクラスがサポートされていないとき: SFERR_CLASS_UNSUPPORTED

戻り値が SFBBaseSmp 型の場合:

  • 成功したとき: 指定した ClassID のオブジェクト
  • そうでないとき: null

解説

この関数は、 指定された ClassID(AEECLSID)のオブジェクトを作成します。

[Note] 注意

正常終了の場合は、指定した ClassID のオブジェクトがこの関数の戻り値として、または、 handle 引数に返されます。

参照

BREW API ISHELL_CreateInstance | AEECLSID | SFBModule::CreateInstance


SFBShell::DetectType
指定されたバッファデータまたはオブジェクトの MIME タイプを取得します。
[ public ]
SFCError DetectType(
    VoidConstPtr data       // データ型を決定する必要のあるデータが含まれるバッファ
    UInt32Ptr size          // 入力時: データバッファのサイズ、出力時: 型検出のために必要な余分のバイト数
    ACharConstPtr name      // データ型を決定する必要のあるオブジェクト名
    ACharConstHandle mime   // 返される MIME 文字列(解放しないこと)
);
[ public ]
SFCError DetectType(
    SFXBufferConstRef data   // データ型を決定する必要のあるデータが含まれるバッファ
    UInt32Ptr additional     // 入力時: バッファサイズに自動的に初期化される、出力時:型検出のために必要な余分のバイト数
    ACharConstPtr name       // データ型を決定する必要のあるオブジェクト名
    ACharConstHandle mime    // 返される MIME 文字列
);
[ public ]
SFCError DetectType(
    VoidConstPtr data            // データ型を決定する必要のあるデータが含まれるバッファ
    UInt32Ptr size               // 入力時: データバッファのサイズ、出力時: 型検出のために必要な余分のバイト数
    SFXAnsiStringConstRef name   // データ型を決定する必要のあるオブジェクト名
    SFXAnsiStringPtr mime        // 返される MIME 文字列(解放しないこと)
);
[ public ]
SFCError DetectType(
    SFXBufferConstRef data       // データ型を決定する必要のあるデータが含まれるバッファ
    UInt32Ptr additional         // 入力時: バッファサイズに自動的に初期化される、出力時:型検出のために必要な余分のバイト数
    SFXAnsiStringConstRef name   // データ型を決定する必要のあるオブジェクト名
    SFXAnsiStringPtr mime        // 返される MIME 文字列(解放しないこと)
);
[ public ]
SFCError DetectType(
    VoidConstPtr data       // データ型を決定する必要のあるデータが含まれるバッファ
    UInt32Ptr size          // 入力時: データバッファのサイズ、出力時: 型検出のために必要な余分のバイト数
    SFXAnsiStringPtr mime   // 返される MIME 文字列(解放しないこと)
);
[ public ]
SFCError DetectType(
    SFXBufferConstRef data   // データ型を決定する必要のあるデータが含まれるバッファ
    UInt32Ptr additional     // 入力時: バッファサイズに自動的に初期化される、出力時:型検出のために必要な余分のバイト数
    SFXAnsiStringPtr mime    // 返される MIME 文字列(解放しないこと)
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • mime / additional 引数が null であるとき: SFERR_INVALID_PARAM
  • 指定したデータの型検出がサポートされていないとき: SFERR_UNSUPPORTED
  • データに型が関連付けられていないとき: ENOTYPE
  • 型検出を実行するためさらにデータが必要なとき(size / additional 引数に必要な追加のバイト数が格納される): ENEEDMORE

解説

この関数は、 指定されたバッファデータまたはオブジェクトの MIME タイプを取得します。

[Tip] Tip

この関数は、通常、データの MIME タイプに関連付けられているハンドラを取得するために使用します。 たとえば、データが標準の MIDI 形式である場合、この関数は MIME "audio/mid" を返します。 この MIME タイプをシェルレジストリを検索し、 ClassID が AEECLSID_MEDIA であるハンドラを取得します。

[Note] 注意

data 引数は、name 引数よりも優先されます。 両方を指定した場合、型検出には最初に data 引数が使われ、次に name 引数が使用されます。

この関数が ENEEDMORE を返した場合は、 操作の続行に必要な追加のバイト数が size / additional 引数に格納されます。 前回指定したバイト数に追加のバイト数を加えて(バッファサイズを拡張して)この関数を再び呼び出します。

参照

BREW API ISHELL_DetectType | SFBShell::GetHandler | SFBShell::CreateInstance


SFBShell::EndDialog
現在アクティブなダイアログを閉じます。
[ public ]
SFCError EndDialog(Void);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • アクティブなダイアログが存在しないとき: SFERR_FAILED

解説

この関数は、 現在アクティブなダイアログを閉じます。

参照

BREW API ISHELL_EndDialog | SFBShell::CreateDialog | SFBShell::GetActiveDialog | SFBDialog::SetFocus | SFBDialog::GetControl


SFBShell::EnumAppletInit
AEE シェルの内部アプリの列挙インデックスをリセットします。
[ public ]
Void EnumAppletInit(Void);

解説

この関数は、 AEE シェルの内部アプリの列挙インデックスをリセットします。

[Tip] Tip

この関数は、SFBShell::EnumNextApplet 関数と一緒に使用します。

使用例

アプリを列挙し、次のアプリの情報を取得します。

SFBShellSmp     shell   = SFBShell::GetInstance();
AEEAppInfo      appInfo = {0};

// アプリの列挙を初期化する
shell->EnumAppletInit();

// 次のアプリの情報を取得する
while(shell->EnumNextApplet(&appInfo)){

    // アプリに関する処理
    ....
}

参照

BREW API ISHELL_EnumAppletInit | SFBShell::EnumNextApplet


SFBShell::EnumNextApplet
次のアプリに関する情報を取得します。
[ public ]
AEECLSID EnumNextApplet(
    AEEAppInfo* info   // 次のアプリ情報を受け取る領域を指すポインタ
);

戻り値

  • 成功したとき: 次のアプリの ClassID
  • 次のアプリが存在しないとき、または info 引数が null のとき: 0

解説

この関数は、 次のアプリに関する情報を取得します。

[Tip] Tip

この関数は、SFBShell::EnumAppletInit 関数と一緒に使用します。

使用例

アプリを列挙し、次のアプリの情報を取得します。

SFBShellSmp     shell   = SFBShell::GetInstance();
AEEAppInfo      appInfo = {0};

// アプリの列挙を初期化する
shell->EnumAppletInit();

// 次のアプリの情報を取得する
while(shell->EnumNextApplet(&appInfo)){

    // アプリに関する処理
    ....
}

参照

BREW API ISHELL_EnumNextApplet | AEEAppInfo | SFBShell::EnumAppletInit


SFBShell::ForceExit
アプリの終了が必要かどうかを判定します。
[ public ]
Bool ForceExit(Void);

戻り値

  • アプリが処理を中止して終了する必要があるとき: true
  • アプリが処理を継続できるとき: false

解説

この関数は、 アプリの終了が必要かどうかを判定します。

[Note] 注意

この関数は、ブラウザなどイベントループ(SFBShell::HandleEvent 関数) から戻るまでにたくさんの処理を行う必要のあるアプリで使用します。

参照

BREW API ISHELL_ForceExit | SFBShell::HandleEvent | SFBShell::Busy


SFBShell::FreeResData
リソースファイルからロードしたデータブロックを解放します。
[ public ]
Void FreeResData(
    VoidPtr data   // 解放するデータブロック
);

解説

この関数は、 リソースファイルからロードしたデータブロックを解放します。

[Note] 注意

data 引数には、SFBShell::LoadResData 関数により確保したデータブロックを指定します。

参照

BREW API ISHELL_FreeResData | SFBShell::LoadResData


SFBShell::GetActiveDialog
現在アクティブなダイアログを取得します。
[ public ]
SFBDialogSmp GetActiveDialog(Void);

戻り値

正常終了した場合は、現在アクティブなダイアログ。 アクティブなダイアログが存在しないか、失敗した場合は null。

解説

この関数は、 現在アクティブなダイアログを取得します。

参照

BREW API ISHELL_GetActiveDialog | SFBShell::CreateDialog | SFBShell::EndDialog | SFBDialog::SetFocus | SFBDialog::GetControl


SFBShell::GetAppAuthor
アクティブなアプリの作成者の名前を取得します。
[ public ]
SInt32 GetAppAuthor(
    WCharPtr buf   // 作成者名を格納するバッファ
    SInt32 size    // バッファサイズ
);
[ public ]
SInt32 GetAppAuthor(
    SFXWideStringPtr string   // 作成者名を格納するバッファ
);

戻り値

格納される作成者名の文字数。 作成者名が見つからなかった場合、または buf 引数が null の場合、0。

解説

この関数は、 アクティブなアプリの作成者の名前を取得します。

使用例

アプリの作成者名を取得します。

SFBShellSmp         shell = SFBShell::GetInstance();
SFXWideString       author;

//文字数を設定する
author.SetLength(20);

// アプリの作成者名を取得する
shell->GetAppAuthor(&author);
// or
shell->GetAppAuthor(author.GetBuffer(), sizeof(WChar) * author.GetLength());

参照

BREW API ISHELL_GetAppAuthor


SFBShell::GetAppCopyright
アクティブなアプリの著作権文字列を取得します。
[ public ]
SInt32 GetAppCopyright(
    WCharPtr buf   // 著作権文字列を格納するバッファ
    SInt32 size    // バッファサイズ
);
[ public ]
SInt32 GetAppCopyright(
    SFXWideStringPtr string   // 著作権文字列を格納するバッファ
);

戻り値

格納される著作権文字列の文字数。 著作権文字列が見つからなかった場合、または buf 引数が null の場合、0。

解説

この関数は、 アクティブなアプリの著作権文字列を取得します。

[Note] 注意

この情報は MIF ファイルから取得します。

使用例

アプリの著作権文字列を取得します。

SFBShellSmp         shell = SFBShell::GetInstance();
SFXWideString       copyright;

//文字数を設定する
copyright.SetLength(30);

// アプリの著作権文字列を取得する
shell->GetAppCopyright(&copyright);
// or
shell->GetAppCopyright(copyright.GetBuffer(), sizeof(WChar) * copyright.GetLength());

参照

BREW API ISHELL_GetAppCopyright


SFBShell::GetAppPrefs
アプリのプリファレンスが含まれる構造体を取得します。
[ public ]
SInt32 GetAppPrefs(
    UInt16 version   // プリファレンスのバージョン
    VoidPtr buf      // プリファレンスデータ
    UInt16 size      // プリファレンスデータのサイズ
);
[ public ]
SInt32 GetAppPrefs(
    UInt16 version     // プリファレンスのバージョン
    SFXBufferPtr buf   // null の場合、バッファとそのサイズとして null と 0 が API に渡される
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • buf 引数が null、または size 引数が不充分であるとき: 0 以外のレコードサイズ

解説

この関数は、 アプリのプリファレンスが含まれる構造体を取得します。

アプリはこれを使って、アプリ固有の設定を保存したり取得できます。

[Tip] Tip

プリファレンスを格納するには、SFBShell::SetAppPrefs 関数を使用します。

参照

BREW API ISHELL_GetAppPrefs | SFBShell::SetAppPrefs


SFBShell::GetAppVersion
アクティブなアプリのバージョン文字列を取得します。
[ public ]
SInt32 GetAppVersion(
    WCharPtr buf   // バージョン文字列を格納するバッファ
    SInt32 size    // バッファサイズ
);
[ public ]
SInt32 GetAppVersion(
    SFXWideStringPtr string   // バージョン文字列を格納するバッファ
);

戻り値

格納されるバージョン文字列の文字数。 バージョン文字列が見つからなかった場合、または buf 引数が null の場合、0。

解説

この関数は、 アクティブなアプリのバージョン文字列を取得します。

[Note] 注意

この情報は MIF ファイルから取得します。

使用例

アプリのバージョン文字列を取得します。

SFBShellSmp         shell = SFBShell::GetInstance();
SFXWideString       version;

// 文字数を設定する
version.SetLength(20);

// アプリのバージョン文字列を取得する
shell->GetAppVersion(&version);
// or
shell->GetAppVersion(version..GetBuffer(), sizeof(WChar) * version.GetLength());

参照

BREW API ISHELL_GetAppVersion


SFBShell::GetClassItemID
指定された ClassID を所有しているモジュールに割り当てられた 32 ビット値を取得します。
[ public ]
UInt32 GetClassItemID(
    AEECLSID clsid   // ClassID
);

戻り値

指定された ClassID を所有しているモジュールに割り当てられた 32 ビット値。 クラスが見つからないか、またはモジュールが静的である場合、0。

解説

この関数は、 指定された ClassID を所有しているモジュールに割り当てられた 32 ビット値を取得します。

バージョン

この関数は、BREW 2.1 から使用可能です。

参照

BREW API ISHELL_GetClassItemID


SFBShell::GetDeviceInfo
デバイス情報を AEE シェルから取得します。
[ public ]
Void GetDeviceInfo(
    AEEDeviceInfo* info   // デバイスの情報を受け取る領域を指すポインタ
);

解説

この関数は、 デバイス情報(サポートしている RAM 容量、表示ディスプレイなど)を AEE シェルから取得します。

[Tip] Tip

SophiaFramework UNIVERSE では、 SFXDevice を使用してデバイス情報を取得できます。

使用例

デバイスの情報を取得します。

SFBShellSmp         shell      = SFBShell::GetInstance();
AEEDeviceInfo       deviceInfo = {0};

// デバイスの情報を取得する
shell->GetDeviceInfo(&deviceInfo);

参照

BREW API ISHELL_GetDeviceInfo | BREW API AEEDeviceInfo | SFXDevice


SFBShell::GetDeviceInfoEx
指定されたデバイス項目 ID に関する情報を取得します。
[ public ]
SFCError GetDeviceInfoEx(
    AEEDeviceItem item   // デバイス項目 ID
    VoidPtr info         // デバイス項目を格納するバッファ
    SInt32Ptr size       // バッファサイズ
);
[ public ]
SFCError GetDeviceInfoEx(
    AEEDeviceItem item   // デバイス項目 ID
    SFXBufferPtr info    // サイズは自動的に変更される
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • size 引数が null であるとき: SFERR_INVALID_PARAM
  • 指定したデバイス項目 ID がサポートされていないとき: EUNSUPPORTED

解説

この関数は、 指定されたデバイス項目 ID に関する情報を取得します。

使用例

チップ ID に関する情報を取得します。

SFBShellSmp     shell    = SFBShell::GetInstance();
WChar           data[32] = {0};
SInt32          size;

// デバイスの情報(チップ ID)を取得する
shell->GetDeviceInfoEx(AEE_DEVICEITEM_CHIP_ID, data, &size);

参照

BREW API ISHELL_GetDeviceInfoEx | AEEDeviceItem | SFXDevice


SFBShell::GetHandler
コンテンツビューアおよびプロトコル方式のハンドラを AEE シェルから取得します。
[ public ]
AEECLSID GetHandler(
    AEECLSID type      // ハンドラタイプ、または基底 ClassID
    ACharConstPtr in   // 入力文字列
);
[ public ]
AEECLSID GetHandler(
    AEECLSID type              // ハンドラタイプ、または基底 ClassID
    SFXAnsiStringConstRef in   // 入力文字列
);

戻り値

関連付けられたハンドラクラスの AEECLSID。 それ以外の場合、0。

解説

この関数は、 コンテンツビューアおよびプロトコル方式のハンドラを AEE シェルから取得します。

参照

BREW API ISHELL_GetHandler | AEEHandlerType | SFBShell::RegisterHandler


SFBShell::GetInstance
SFBShell インスタンスを取得します。
[ public, static ]
SFBShellSmp GetInstance(Void);

戻り値

SFBShell インスタンス。

解説

この関数は、 SFBShell インスタンスを取得します。

使用例

SFBShell インスタンスを取得します。

SFBShellSmp     shell = SFBShell::GetInstance();

SFBShell::GetItemStyle
メニュー、アイコン、またはリスト項目のデフォルトスタイルに関する情報を AEE シェルから取得します。
[ public ]
Void GetItemStyle(
    AEEItemType type         // 項目タイプ
    AEEItemStyle* normal     // 選択されていない項目のスタイルを受け取る領域を指すポインタ
    AEEItemStyle* selected   // 選択中の項目のスタイルを受け取る領域を指すポインタ
);

解説

この関数は、 メニュー、アイコン、またはリスト項目のデフォルトスタイルに関する情報を AEE シェルから取得します。

参照

BREW API ISHELL_GetItemStyle | AEEItemType | AEEItemStyle


SFBShell::GetJulianDate
指定された秒数に基づいて JulianType データ構造体を取得します。
[ public ]
Void GetJulianDate(
    UInt32 seconds     // 1980 年 1 月 6 日からの秒数
    JulianType* date   // 日付データを受け取る領域を指すポインタ
);

解説

この関数は、 指定された秒数に基づいて JulianType データ構造体を取得します。

参照

BREW API ISHELL_GetJulianDate | JulianType | GET_JULIANDATE | SFBShell::GetTimeMS | SFBShell::GetUpTimeMS | GET_SECONDS | GET_TIMEMS | GETTIMESECONDS | GETTIMEMS


SFBShell::GetPrefs
指定された ClassID のアプリまたはクラスのレベルプリファレンスが含まれる構造体を取得します。
[ public ]
SInt32 GetPrefs(
    AEECLSID clsid   // ClassID
    UInt16 version   // バージョン
    VoidPtr config   // プリファレンスデータ
    UInt16 size      // プリファレンスデータサイズ
);
[ public ]
SInt32 GetPrefs(
    AEECLSID clsid        // ClassID
    UInt16 version        // バージョン
    SFXBufferPtr config   // null の場合、バッファポインタとそのサイズを null , 0 として API が呼ばれる
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • config 引数が null、または size 引数が不充分であるとき: 0 以外のレコードサイズ
  • 失敗したとき: SFERR_FAILED

解説

この関数は、 指定された ClassID のアプリまたはクラスのレベルプリファレンスが含まれる構造体を取得します。

参照

BREW API ISHELL_GetPrefs | SFBShell::SetPrefs


SFBShell::GetProperty
入力クラスに関連付けられている基本モジュールのプロパティデータを取得します。
[ public ]
SFCError GetProperty(
    AEECLSID clsid   // 問い合わせるアプリの ClassID
    UInt16 wId       // プロパティ ID
    VoidPtr dest     // バッファ(読み込み先)
    UInt16Ptr size   // バッファのサイズ
);
[ public ]
SFCError GetProperty(
    AEECLSID clsid      // 問い合わせるアプリのクラス
    UInt16 wId          // プロパティ ID
    SFXBufferPtr dest   // バッファ(読み込み先)
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • dest 引数が null であるとき: SFERR_INVALID_PARAM
  • メモリ不足のとき: SFERR_NO_MEMORY
  • 入力クラスが見つからないとき: EBADCLASS
  • 特権がないとき: EPRIVLEVEL

解説

この関数は、 入力クラスに関連付けられている基本モジュールのプロパティデータを取得します。

バージョン

この関数は、BREW 3.1 から使用可能です。

参照

BREW API ISHELL_GetProperty | SFBShell::SetProperty


SFBShell::GetResSize
指定されたリソースファイルから指定されたタイプと ID のリソースをロードします。
[ public ]
UInt32 GetResSize(
    ACharConstPtr file   // リソースファイル
    UInt16 id            // リソース ID
    ResType type         // リソースのタイプ
    UInt32Ptr size       // バッファサイズ
);
[ public ]
UInt32 GetResSize(
    SFXAnsiStringConstRef file   
    UInt16 id                    
    ResType type                 
    UInt32Ptr size               
);

戻り値

見つかったリソースのサイズ。 失敗した場合、0。

解説

この関数は、 指定されたリソースファイルから指定されたタイプと ID のリソースをロードします。

SFBShell::LoadResDataEx 関数のラッパー関数です。

参照

BREW API ISHELL_GetResSize | SFBShell::LoadResDataEx


SFBShell::GetTimeMS
現在の時刻を取得します。[単位: ミリ秒]
[ public ]
UInt32 GetTimeMS(Void);

戻り値

午前零時からの経過時間。 [単位: ミリ秒]

解説

この関数は、 現在の時刻を取得します。[単位: ミリ秒]

参照

BREW API ISHELL_GetTimeMS | SFBShell::GetUpTimeMS | SFBShell::GetJulianDate


SFBShell::GetTimerExpiration
指定されたデバイスのユーザーコールバックまたはユーザーデータに関連付けられたタイマーが満了するまでの残存時間をで取得します。[単位: ミリ秒]
[ public ]
UInt32 GetTimerExpiration(
    PFNNOTIFY notify      // コールバック関数
    VoidPtr data = null   // ユーザーデータ
);

戻り値

デバイスのユーザーコールバックまたはユーザーデータに関連付けられたタイマーが満了するまでの残存時間。[単位: ミリ秒]

タイマーが満了している場合、0。

解説

この関数は、 指定されたデバイスのユーザーコールバックまたはユーザーデータに関連付けられたタイマーが満了するまでの残存時間をで取得します。[単位: ミリ秒]

使用例

タイマー満了までの残り時間を取得します。

// タイマー用コールバック関数
static Void OnTimerEntry(VoidPtr arg);

SFBShellSmp     shell    = SFBShell::GetInstance();
UInt32          duration = 0;

// タイマー満了までの残り時間を取得する
duration = shell->GetTimerExpiration(OnTimerEntry, this);

参照

BREW API ISHELL_GetTimerExpiration | PFNNOTIFY | SFBShell::SetTimer | SFBShell::CancelTimer


SFBShell::GetUpTimeMS
デバイスに電源が投入されてからの経過時間を取得します。[単位: ミリ秒]
[ public ]
UInt32 GetUpTimeMS(Void);

戻り値

デバイスに電源が投入されてからの経過時間。[単位: ミリ秒]

解説

この関数は、 デバイスに電源が投入されてからの経過時間を取得します。[単位: ミリ秒]

参照

BREW API ISHELL_GetUpTimeMS | SFBShell::GetTimeMS | SFBShell::GetJulianDate


SFBShell::HandleEvent
指定された標準 AEE イベントを現在アクティブなアプリに送信します。
[ public ]
Bool HandleEvent(
    AEEEvent event   // 標準 AEE イベント(EVT_COMMAND 以上 EVT_USER 未満の範囲にあるイベント)
    UInt16 wParam    // イベント固有の 16 ビット値
    UInt32 dwParam   // イベント固有の 32 ビット値
);
[ public ]
Bool HandleEvent(
    SFXEventConstRef event   // イベント
);

戻り値

  • イベントが処理されたとき: true
  • そうでないとき: false

解説

この関数は、 指定された標準 AEE イベントを現在アクティブなアプリに送信します。

標準 AEE イベントとは、 EVT_COMMAND 以上 EVT_USER 未満の範囲にあるイベントです。

[Note] 注意

この関数は、内部的に ClassID に 0 を指定して SFBShell::SendEvent 関数を呼び出します。

EVT_COMMAND 以上 EVT_USER 未満の範囲のイベントのみ送信可能です。 EVT_USER 以上のイベントは送信できません。 EVT_USER 以上のイベントを送信する場合は、 SFBShell::SendEvent / SFBShell::PostEvent 関数を使用します。

この関数は、ユーザーがコントロールを実装する場合に使用します。 たとえば、コントロールがイベント EVT_CTL_TAB イベントを現在アクティブなアプリに送信する場合に使用します。

一般に、アプリがイベントを自分自身、または他のアプリに送信するには、 SFBShell::SendEvent または SFBShell::PostEvent 関数を使用します。

[Note] イベント固有の 16 / 32 ビット値の検査について

AEE シェルは、イベント固有の 16 / 32 ビット値を検査しません。

参照

BREW API ISHELL_HandleEvent | AEEEvent | SFBShell::SendEvent | SFBShell::PostEvent


SFBShell::IsValidResource
指定されたリソースファイルのエントリが、 指定されたタイプについて有効かどうかを判定します。
[ public ]
Bool IsValidResource(
    ACharConstPtr file           // リソースファイル
    UInt16 id                    // リソース ID
    ResType resType              // リソースタイプ
    AEEHandlerType handlerType   // ハンドラタイプ: resType 引数が RESTYPE_IMAGE でない場合は無視される
);
[ public ]
Bool IsValidResource(
    SFXAnsiStringConstRef file   // リソースファイル
    UInt16 id                    // リソース ID
    ResType resType              // リソースタイプ
    AEEHandlerType handlerType   // ハンドラタイプ: resType 引数が RESTYPE_IMAGE でない場合は無視される
);

戻り値

  • リソースがファイル内に存在しているとき: true
  • そうでないとき: false

解説

この関数は、 指定されたリソースファイルのエントリが、 指定されたタイプについて有効かどうかを判定します。

resType 引数に有効な値は以下のとおりです。

  • RESTYPE_STRING: UNICODE または ISOLATIN 文字列から作成される文字列リソース。
  • RESTYPE_IMAGE: BMP、PNG、または GIF 画像から作成される画像リソース。
  • RESTYPE_DIALOG: 1 つまたは複数のダイアログコントロールから作成されるダイアログリソース。
  • RESTYPE_CONTROL: コントロールリソース。
  • RESTYPE_LISTITEM: リスト項目タイプリソース。
  • RESTYPE_BINARY: バイナリデータリソース。

handlerType 引数に有効な値は以下のとおりです。

  • HTYPE_VIEWER: 画像表示サービスを提供する SFBViewer クラスのハンドラを指定する(非修飾の"image/\*" MIME型用)。
  • HTYPE_SOUND: サウンド再生サービスを提供する SFBSoundPlayer クラスのハンドラを指定する(非修飾の"snd/\*" MIME型用)。
  • HTYPE_BROWSE: いずれかのスキーム(http、mailtoなど)またはファイル拡張子(.gif、.htmなど)をサポートする SFBApplet クラスのハンドラを指定する。 HTYPE_BROWSE は充分サポートされていないため、推奨されません。

参照

BREW API ISHELL_IsValidResource | ResType | AEEHandlerType


SFBShell::LoadBitmap
指定されたファイルからビットマップを直接ロードします。
[ public ]
SFBBitmapSmp LoadBitmap(
    ACharConstPtr file   // ファイル名
);
[ public ]
SFBBitmapSmp LoadBitmap(
    SFXAnsiStringConstRef file   // ファイル名
);

戻り値

指定されたファイルから読み込んだビットマップ。

エラーの場合は null。

解説

この関数は、 指定されたファイルからビットマップを直接ロードします。

参照

BREW API ISHELL_LoadBitmap | SFBShell::LoadResBitmap SFBShell::LoadImage | SFBShell::LoadResData | SFBShell::LoadResDataEx | SFBShell::LoadResImage | SFBShell::LoadResObject | SFBShell::LoadResSound | SFBShell::LoadSound | SFBBitmap


SFBShell::LoadBusyImage
BREW がビジーであることを示すために使われる画像をロードします。
[ public ]
SFBImageSmp LoadBusyImage(Void);

戻り値

BREW がビジーであることを示すために使われる画像。

エラーの場合は null。

解説

この関数は、 BREW がビジーであることを示すために使われる画像をロードします。

参照

BREW API ISHELL_LoadBusyImage | SFBShell::LoadImage | SFBShell::LoadBitmap SFBShell::LoadResBitmap SFBShell::LoadResData | SFBShell::LoadResDataEx | SFBShell::LoadResImage | SFBShell::LoadResObject | SFBShell::LoadResSound | SFBShell::LoadResString | SFBShell::LoadSound | SFBShell::FreeResData | SFBImage


SFBShell::LoadImage
指定されたファイルからイメージデータを直接ロードします。
[ public ]
SFBImageSmp LoadImage(
    ACharConstPtr file   // ファイル名
);
[ public ]
SFBImageSmp LoadImage(
    SFXAnsiStringConstRef file   // ファイル名
);

戻り値

指定されたファイルから読み込んだイメージデータ。

エラーの場合は null。

解説

この関数は、 指定されたファイルからイメージデータを直接ロードします。

参照

BREW API ISHELL_LoadImage | SFBShell::LoadBitmap SFBShell::LoadResBitmap SFBShell::LoadResData | SFBShell::LoadResDataEx | SFBShell::LoadResImage | SFBShell::LoadResObject | SFBShell::LoadResSound | SFBShell::LoadResString | SFBShell::LoadSound | SFBShell::FreeResData | SFBImage


SFBShell::LoadResBitmap
指定されたリソースファイル内の指定されたリソース ID のビットマップをロードします。
[ public ]
SFBBitmapSmp LoadResBitmap(
    ACharConstPtr resFile   // リソースファイル
    UInt16 id               // リソース ID
);
[ public ]
SFBBitmapSmp LoadResBitmap(
    SFXAnsiStringConstRef resFile   // リソースファイル
    UInt16 id                       // リソース ID
);

戻り値

指定されたリソースファイル内の指定されたリソース ID のビットマップ。

エラーの場合は null。

解説

この関数は、 指定されたリソースファイル内の指定されたリソース ID のビットマップをロードします。

使用例

リソースファイルからビットマップを取得し、 端末画面に表示します。

// リソースファイルから読み込むビットマップのリソース ID
#define IDB_MY_PICTURE  0x0001

SFBShellSmp         shell   = SFBShell::GetInstance();
SFBDisplaySmp       display = SFBDisplay::NewInstance();
SFBBitmapSmp        bmp;

// リソースファイルからビットマップを取得する
bmp = shell->LoadResBitmap(MYRESOURCE_RES_FILE, IDB_MY_PICTURE);

if (bmp != null) {
    // ビットマップを描画する
    display->BitBlt(SFXRectangle(0, 0, 100, 100), bmp, SFXGrid(0, 0));

    // 画面を更新する
    display->Update();
}

参照

BREW API ISHELL_LoadResBitmap | SFBShell::LoadBitmap | SFBBitmap


SFBShell::LoadResData
指定されたリソースファイル内の指定されたリソース ID、リソースタイプのデータブロックをロードします。
[ public ]
VoidPtr LoadResData(
    ACharConstPtr resFile   // リソースファイル
    UInt16 id               // リソース ID
    ResType type            // リソースタイプ
);
[ public ]
VoidPtr LoadResData(
    SFXAnsiStringConstRef resFile   // リソースファイル
    UInt16 id                       // リソース ID
    ResType type                    // リソースタイプ
);

戻り値

リソースファイルからロードしたデータブロック。

エラーの場合は null。

解説

この関数は、 指定されたリソースファイル内の指定されたリソース ID、リソースタイプのデータブロックをロードします。

参照

BREW API ISHELL_LoadResData | ResType | SFBShell::FreeResData | SFBShell::LoadImage | SFBShell::LoadBitmap SFBShell::LoadResBitmap SFBShell::LoadResDataEx | SFBShell::LoadResImage | SFBShell::LoadResObject | SFBShell::LoadResSound | SFBShell::LoadResString | SFBShell::LoadSound


SFBShell::LoadResDataEx
指定されたリソースファイル内の指定されたリソース ID、リソースタイプのデータブロックをロードします (データは buf 引数に指定したバッファに格納されます)。
[ public ]
VoidPtr LoadResDataEx(
    ACharConstPtr resFile   // リソースファイル
    UInt16 id               // リソース ID
    ResType type            // リソースタイプ
    VoidPtr buf             // リソースデータを格納するバッファ
    UInt32Ptr size          // バッファサイズ
);
[ public ]
VoidPtr LoadResDataEx(
    SFXAnsiStringConstRef resFile   // リソースファイル
    UInt16 id                       // リソース ID
    ResType type                    // リソース タイプ
    VoidPtr buf                     // リソース データを格納するバッファ
    UInt32Ptr size                  // バッファサイズ
);
[ public ]
VoidPtr LoadResDataEx(
    SFXAnsiStringConstRef resFile   // リソースファイル
    UInt16 id                       // リソース ID
    ResType type                    // リソース タイプ
    SFXBufferPtr buf                // リソース データを格納するバッファ
);

戻り値

指定されたリソースファイル内の指定されたリソース ID、リソースタイプのデータブロック (データは buf 引数に指定したバッファに格納されます)。

エラーの場合は null。

解説

この関数は、 指定されたリソースファイル内の指定されたリソース ID、リソースタイプのデータブロックをロードします (データは buf 引数に指定したバッファに格納されます)。

参照

BREW API ISHELL_LoadResDataEx | SFBShell::LoadImage | SFBShell::LoadBitmap SFBShell::LoadResBitmap SFBShell::LoadResData | SFBShell::LoadResImage | SFBShell::LoadResObject | SFBShell::LoadResSound | SFBShell::LoadResString | SFBShell::LoadSound | SFBShell::FreeResData | AEEResBlob


SFBShell::LoadResImage
指定されたリソースファイル内の指定されたリソース ID のイメージをロードします。
[ public ]
SFBImageSmp LoadResImage(
    ACharConstPtr resFile   // リソースファイル
    UInt16 id               // リソース ID
);
[ public ]
SFBImageSmp LoadResImage(
    SFXAnsiStringConstRef resFile   // リソースファイル
    UInt16 id                       // リソース ID
);

戻り値

指定されたリソースファイル内の指定されたリソース ID のイメージ。

エラーの場合は null。

解説

この関数は、 指定されたリソースファイル内の指定されたリソース ID のイメージをロードします。

使用例

リソースファイルからビットマップイメージを取得し、 端末画面に表示します。

// リソースファイルから読み込むビットマップのリソース ID
#define IDB_MY_PICTURE  0x0001

SFBShellSmp     shell     = SFBShell::GetInstance();
SFBImageSmp     image;
AEEImageInfo    imageInfo = {0};

// リソースファイルからイメージ(ビットマップイメージ)を取得する
image = shell->LoadResImage(MYRESOURCE_RES_FILE, IDB_MY_PICTURE);

if (image != null) {
    // イメージの情報を取得する
    image->GetInfo(&imageInfo);

    // SFBImage オブジェクトがイメージを持つかを確認する
    if (imageInfo.cx == 0) {
        DBGPRINTF("Failed to load image ... !");
        image.Release();
    }
    else {
        // イメージを描画する
        image->Draw(0, 0);
    }
}

参照

BREW API ISHELL_LoadResImage | SFBShell::LoadImage | SFBShell::LoadResData | SFBShell::LoadResDataEx | SFBShell::LoadResObject | SFBShell::LoadResSound | SFBShell::LoadResString | SFBShell::LoadSound | SFBShell::FreeResData | SFBImage


SFBShell::LoadResObject
指定されたリソースファイル内の指定されたリソース ID、リソースタイプのオブジェクトをロードします。
[ public ]
SFBBaseSmp LoadResObject(
    ACharConstPtr resFile   // リソースファイル
    UInt16 id               // リソース ID
    AEECLSID clsidBase      // リソースタイプ
);
[ public ]
SFBBaseSmp LoadResObject(
    SFXAnsiStringConstRef resFile   // リソースファイル
    UInt16 id                       // リソース ID
    AEECLSID clsidBase              // リソースタイプ
);

戻り値

指定されたリソースファイル内の指定されたリソース ID、リソースタイプのオブジェクト。

エラーの場合は null。

解説

この関数は、 指定されたリソースファイル内の指定されたリソース ID、リソースタイプのオブジェクトをロードします。

参照

BREW API ISHELL_LoadResObject | SFBShell::LoadImage | SFBShell::LoadBitmap SFBShell::LoadResBitmap SFBShell::LoadResData | SFBShell::LoadResDataEx | SFBShell::LoadResImage | SFBShell::LoadResSound | SFBShell::LoadResString | SFBShell::LoadSound | SFBShell::FreeResData | SFBBase


SFBShell::LoadResSound
指定されたリソースファイル内の指定されたリソース ID の音声データをロードします。
[ public ]
SFBSoundPlayerSmp LoadResSound(
    ACharConstPtr resFile   // リソースファイル
    UInt16 id               // リソース ID
);
[ public ]
SFBSoundPlayerSmp LoadResSound(
    SFXAnsiStringConstRef resFile   // リソースファイル
    UInt16 id                       // リソース ID
);

戻り値

指定されたリソースファイル内の指定されたリソース ID の音声データ。

エラーの場合は null。

解説

この関数は、 指定されたリソースファイル内の指定されたリソース ID の音声データをロードします。

[Note] 注意

この関数は、 リソースファイルに未加工のストリームバイトのサウンドデータが含まれている場合に使用します。

参照

BREW API ISHELL_LoadResSound | SFBShell::LoadImage | SFBShell::LoadBitmap SFBShell::LoadResBitmap SFBShell::LoadResData | SFBShell::LoadResDataEx | SFBShell::LoadResImage | SFBShell::LoadResObject | SFBShell::LoadResString | SFBShell::LoadSound | SFBSoundPlayer


SFBShell::LoadResString
指定されたリソースファイル内の指定されたリソース ID の UNICODE または ISOLATIN 文字列をロードします (文字列は buf 引数に指定したバッファに格納されます)。
[ public ]
SInt32 LoadResString(
    ACharConstPtr resFile   // リソースファイル
    UInt16 id               // リソース ID
    WCharPtr buf            // 文字列を格納するバッファ
    SInt32 size             // バッファサイズ
);
[ public ]
SFXWideString LoadResString(
    SFXAnsiStringConstRef resFile   // リソースファイル
    UInt16 id                       // リソース ID
);
[ public ]
SInt32 LoadResString(
    ACharConstPtr resFile     // リソースファイル
    UInt16 id                 // リソース ID
    SFXWideStringPtr string   // 文字列を格納するバッファ
);
[ public ]
SInt32 LoadResString(
    SFXAnsiStringConstRef resFile   // リソースファイル
    UInt16 id                       // リソース ID
    SFXWideStringPtr string         // 文字列を格納するバッファ
);

戻り値

戻り値が SInt32 型の場合:

指定されたリソースファイル内の指定されたリソース ID の UNICODE または ISOLATIN 文字列の長さ (データは buf 引数に指定したバッファに格納されます)。エラーの場合は 0。

解説

この関数は、 指定されたリソースファイル内の指定されたリソース ID の UNICODE または ISOLATIN 文字列をロードします (文字列は buf 引数に指定したバッファに格納されます)。

使用例

リソースファイルから文字列を取得し、 端末画面に表示します。

// リソースファイルから読み込む文字列のリソース ID
#define IDS_MY_LETTERS  0x0011

SFBShellSmp         shell   = SFBShell::GetInstance();
SFBDisplaySmp       display = SFBDisplay::NewInstance();
SFXWideString       string;

// リソースファイルから文字列を取得する
if (shell->LoadResString(MYRESOURCE_RES_FILE, IDS_MY_LETTERS, &string)) {

    // 画面に文字列を表示する
    display->DrawText(AEE_FONT_BOLD, string, -1, 0, 0, null, IDF_ALIGN_CENTER | IDF_ALIGN_MIDDLE);

    // 画面を更新する
    display->Update();
}

参照

BREW API ISHELL_LoadResString | SFBShell::LoadImage | SFBShell::LoadBitmap SFBShell::LoadResBitmap SFBShell::LoadResData | SFBShell::LoadResDataEx | SFBShell::LoadResImage | SFBShell::LoadResObject | SFBShell::LoadResSound | SFBShell::LoadSound | SFXWideString


SFBShell::LoadSound
指定されたファイルからサウンドデータをロードします。
[ public ]
SFBSoundPlayerSmp LoadSound(
    ACharConstPtr resFile   // ファイル名
);
[ public ]
SFBSoundPlayerSmp LoadSound(
    SFXAnsiStringConstRef resFile   // ファイル名
);

戻り値

指定されたファイルから読み込んだサウンドデータ。

エラーの場合は null。

解説

この関数は、 指定されたファイルからサウンドデータをロードします。

[Note] 注意

この関数は、内部で SFBShell::LoadResObject 関数を呼び出します。

参照

BREW API ISHELL_LoadSound | SFBShell::LoadResObject | SFBShell::LoadImage | SFBShell::LoadBitmap SFBShell::LoadResBitmap SFBShell::LoadResData | SFBShell::LoadResDataEx | SFBShell::LoadResImage | SFBShell::LoadResSound | SFBShell::LoadResString | SFBShell::FreeResData | SFBSoundPlayer


SFBShell::MessageBox
指定されたリソースファイルから指定された ID のタイトルとテキストを取得し、 メッセージボックスを作成して表示します。
[ public ]
Bool MessageBox(
    ACharConstPtr resFile   // リソースファイル
    UInt16 titleId          // タイトル ID
    UInt16 textId           // テキスト ID
);
[ public ]
Bool MessageBox(
    SFXAnsiStringConstRef resFile   // リソースファイル
    UInt16 titleId                  // タイトル ID: タイトルの最大サイズは 128 バイト(Unicode で 64文字)
    UInt16 textId                   // テキスト ID: テキストの最大サイズは 256 バイト(Unicode で 128文字)
);

引数

resFile

リソースファイル: タイトルとテキストが含まれるリソースファイル。 null の場合、 言語ディレクトリ "en" 内の BREW リソースファイル(AEEControls.bar)が使用される。

titleId

タイトル ID: タイトルの最大サイズは 128 バイト(Unicode で 64文字)。

textId

テキスト ID: テキストの最大サイズは 256 バイト(Unicode で 128文字)。

戻り値

  • 成功したとき: true
  • そうでないとき: false

解説

この関数は、 指定されたリソースファイルから指定された ID のタイトルとテキストを取得し、 メッセージボックスを作成して表示します。

[Note] 注意

メッセージボックスは、タイトルとテキストを表示するウィンドウです。 CLR キーを押下すると閉じます。

[Caution] 注意

タイトルまたはテキストのいずれかが最大サイズを超える場合は、 メッセージボックスは作成されません。

参照

BREW API ISHELL_MessageBox | SFBShell::MessageBoxText


SFBShell::MessageBoxText
指定されたタイトル文字列とテキスト文字列からメッセージボックスを作成し表示します。
[ public ]
Bool MessageBoxText(
    WCharConstPtr title   // タイトル文字列
    WCharConstPtr text    // テキスト文字列
);
[ public ]
Bool MessageBoxText(
    SFXWideStringConstRef title   // タイトル文字列
    SFXWideStringConstRef text    // テキスト文字列
);

戻り値

  • 成功したとき: true
  • そうでないとき: false

解説

この関数は、 指定されたタイトル文字列とテキスト文字列からメッセージボックスを作成し表示します。

[Note] 注意

メッセージボックスは、タイトルとテキストを表示するウィンドウです。 CLR キーを押下すると閉じます。

[Caution] 注意

タイトルまたはテキストのいずれかが最大サイズを超える場合は、 メッセージボックスは作成されません。

参照

BREW API ISHELL_MessageBoxText | SFBShell::MessageBox


SFBShell::Notify
指定されたアプリに指定されたイベントが発生したことを通知します。
[ public ]
SFCError Notify(
    AEECLSID clsid   // 通知先アプリの ClassID
    UInt32 mask      // イベントマスク(どのイベントが発生したかを表す)
    VoidPtr data     // コンテキスト依存データ
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • ClassID が無効であるとき: EBADCLASS
  • 引数が無効であるとき: SFERR_INVALID_PARAM
  • メモリ不足のとき: SFERR_NO_MEMORY
  • 現在の通知内から SFBShell::Notify 関数を呼び出したとき: EREENTERED
  • 通知発行タスクが無効であるとき: EBADTASK
  • 失敗したとき: SFERR_FAILED

解説

この関数は、 指定されたアプリに指定されたイベントが発生したことを通知します。

[Note] 注意

イベントマスクは発生したイベントの種類を表し、 イベントを発行するクラスで定義します。 イベントが発生すると、 SFBShell::RegisterNotify 関数でに登録したすべてのアプリが呼び出されます。

指定されたアプリが現在アクティブでない場合は、ロードされイベントが送られます。 この場合は、EVT_APP_START または EVT_APP_STOP イベントは送られません。

イベントに基づいてアプリを起動する場合は、 SFBShell::StartApplet 関数を呼び出す必要があります。

参照

BREW API ISHELL_Notify | SFBShell::RegisterNotify | SFBShell::StartApplet


SFBShell::OnAppClose
アプリ終了時に呼び出されるコールバックを登録します。
[ public ]
Void OnAppClose(
    SFXCallbackPtr callback   // コールバック
);

解説

この関数は、 アプリ終了時に呼び出されるコールバックを登録します。

参照

BREW API ISHELL_OnAppClose | SFXCallback


SFBShell::OnExit
BREW 終了時に呼び出されるコールバックを登録します。
[ public ]
Void OnExit(
    SFXCallbackPtr callback   // コールバック
);

解説

この関数は、 BREW 終了時に呼び出されるコールバックを登録します。

参照

BREW API ISHELL_OnExit | SFXCallback


SFBShell::OnInit
BREW 初期化時に呼び出されるコールバックを登録します。
[ public ]
Void OnInit(
    SFXCallbackPtr callback   // コールバック
);

解説

この関数は、 BREW 初期化時に呼び出されるコールバックを登録します。

参照

BREW API ISHELL_OnInit


SFBShell::OnLowRAM
システムのメモリが少量になったときに呼び出されるコールバックを登録します。
[ public ]
Void OnLowRAM(
    SFXCallbackPtr callback   // コールバック
);

解説

この関数は、 システムのメモリが少量になったときに呼び出されるコールバックを登録します。

[Note] 注意

この関数を利用して、 アプリはメモリのクリーンアップを行い、システム用にメモリを解放することが可能です。

参照

BREW API ISHELL_OnLowRAM


SFBShell::OnLowRAMCritical
システムメモリが少なくなり、AEE_SCB_LOW_RAM コールバックによっても充分なメモリを確保できない場合に呼び出されるコールバックを登録します。
[ public ]
Void OnLowRAMCritical(
    SFXCallbackPtr callback   // コールバック
);

バージョン

この関数は、BREW 3.1 から使用可能です。

解説

この関数は、 システムメモリが少なくなり、SFBShell::OnLowRAM 関数で登録する AEE_SCB_LOW_RAM コールバックによっても充分なメモリを確保できない場合に呼び出されるコールバックを登録します。

[Note] 注意

この関数を利用して、 アプリはメモリのクリーンアップを行い、システム用にメモリを解放することが可能です。

コールバックを正常に登録するためには、 呼び出し側アプリが AEEGROUPID_LOW_RAM グループに属している必要があります。

参照

BREW API ISHELL_OnLowRAMCritical | SFBShell::OnLowRAM


SFBShell::OnLowStorage
ファイルシステム容量が少量になったときに呼び出されるコールバックを登録します。
[ public ]
Void OnLowStorage(
    SFXCallbackPtr callback   // コールバック
);

解説

この関数は、 ファイルシステム容量が少量になったときに呼び出されるコールバックを登録します。

[Note] 注意

この関数を利用して、 アプリはファイルシステムのクリーンアップを行い、システム用にファイルシステム容量を解放することが可能です。

参照

BREW API ISHELL_OnLowStorage


SFBShell::OnModUnload
モジュールがアンロードされる直前に呼び出されるコールバックを登録します。
[ public ]
Void OnModUnload(
    SFXCallbackPtr callback   // コールバック
);

解説

この関数は、 モジュールがアンロードされる直前に呼び出されるコールバックを登録します。

[Note] 注意

コールバックはクライアント側で割り当てる必要があります。

参照

BREW API ISHELL_OnModUnload | SFBShell::RegisterSystemCallback


SFBShell::PostEvent
指定されたアプリに指定された非同期イベントをポストします。
[ public ]
Bool PostEvent(
    AEECLSID clsid   // イベントを受け取るアプリの ClassID(EVT_USER 以上のイベントには必須)
    AEEEvent event   // AEE イベント
    UInt16 wValue    // イベント固有の 16 ビット値
    UInt32 dwValue   // イベント固有の 32 ビット値
);
[ public ]
Bool PostEvent(
    AEECLSID clsid           // イベントを受け取るアプリの ClassID(EVT_USER 以上のイベントには必須)
    SFXEventConstRef event   // イベント
);

戻り値

  • イベントがポストされたとき: true
  • そうでないとき: false

解説

この関数は、 指定されたアプリに指定された非同期イベントをポストします。

clsid 引数にアプリの ClassID を指定することで、 EVT_USER 以上のユーザーイベントをアプリにポストすることが可能です。 ClassID を指定せずに EVT_USER 以上のイベントをポストした場合、イベントのポストは失敗します。

戻り値は、イベントが正常にポスト(イベントキューに追加)されたかどうかのみを表します。 イベントが正常に受信側アプリへ送信されたことを意味しません。

[Note] SFBShell::SendEvent 関数との違い

SFBShell::SendEvent 関数がアプリに即座にイベントを送信するのに対し、 この関数は、アプリにイベントをポスト(イベントキューに追加)するだけです。

アプリが EVT_APP_STOP イベントを受信して終了処理を行うときに、 イベントキューにポストされて残っているイベントはキャンセルされ、アプリには送信されません。

[Note] SFBShell::PostEventEx 関数との違い

この関数は、 SFBShell::PostEventEx 関数と異なり、 アプリに対して同一タイプのイベント(=同じイベントコードを持つイベント)を複数ポストできません。

[Note] イベント固有の 16 / 32 ビット値の検査について

AEE シェルは、イベント固有の 16 / 32 ビット値を検査しません。

使用例

アプリに強制再描画イベントをポストします。

SFBShellSmp     shell = SFBShell::GetInstance();

// アプリに強制再描画イベントをポストする
shell->PostEvent(SFCApplet::GetClassID(), SFXEvent(SREVT_RESPONDER_RENDER, SRP16_RENDER_INVOKE, true));

参照

BREW API ISHELL_PostEvent | AEEEvent | AEECLSID | SFBShell::PostEventEx | SFBShell::SendEvent


SFBShell::PostEventEx
指定されたアプリに指定された非同期イベントをポストします。
[ public ]
Bool PostEventEx(
    UInt16 flags     // 通常の使用では、0 を指定する
                     // EVTFLG_UNIQUE を指定した場合は、SFBShell::PostEvent 関数と同じになる
    AEECLSID clsid   // イベントを受け取るアプリの ClassID(EVT_USER 以上のイベントには必須)
    AEEEvent event   // AEE イベント
    UInt16 wValue    // イベント固有の 16 ビット値
    UInt32 dwValue   // イベント固有の 32 ビット値
);
[ public ]
Bool PostEventEx(
    UInt16 flags             // 通常の使用では、0 を指定する
                     // EVTFLG_UNIQUE を指定した場合は、SFBShell::PostEvent 関数と同じになる
    AEECLSID clsid           // イベントを受け取るアプリの ClassID(EVT_USER 以上のイベントには必須)
    SFXEventConstRef event   // イベント
);

戻り値

  • イベントがポストされたとき: true
  • そうでないとき: false

解説

この関数は、 指定されたアプリに指定された非同期イベントをポストします。

clsid 引数にアプリの ClassID を指定することで、 EVT_USER 以上のユーザーイベントをアプリに送信することが可能です。 ClassID を指定せずに EVT_USER 以上のイベントをポストした場合、イベントのポストは失敗します。

戻り値は、イベントが正常にポスト(イベントキューに追加)されたかどうかのみを表します。 イベントが正常に受信側アプリへ送信されたことを意味しません。

[Note] 注意

SFBShell::SendEvent 関数がアプリに即座にイベントを送信するのに対し、 この関数は、アプリにイベントをポスト(イベントキューに追加)するだけです。

アプリが EVT_APP_STOP イベントを受信して終了処理を行うときに、 イベントキューにポストされて残っているイベントはキャンセルされ、アプリには送信されません。

[Note] SFBShell::PostEvent 関数との違い

この関数は、 SFBShell::PostEvent 関数と異なり、 アプリに対して同一タイプのイベント(=同じイベントコードを持つイベント)を複数ポストできます。

[Note] flags 引数について

一般に、flags 引数には 0 を指定します。

EVTFLG_UNIQUE を指定することもできますが、 このフラグはこのイベントタイプの 1 つだけをいつでも待機中にできることを示すものです。 この場合は、この関数は、SFBShell::PostEvent 関数と同じになります。

[Note] イベント固有の 16 / 32 ビット値の検査について

AEE シェルは、イベント固有の 16 / 32 ビット値を検査しません。

バージョン

この関数は、BREW 2.1 から使用可能です。

参照

BREW API ISHELL_PostEventEx | AEEEvent | AEECLSID | SFBShell::PostEvent | SFBShell::SendEvent


SFBShell::PostURL
URL のスキームに関連付けられたアプリに対し、非同期のイベントとして EVT_APP_POST_URL イベントをポストします。
[ public ]
Bool PostURL(
    ACharConstPtr url   // URL へのポインタ
);

戻り値

  • イベントがポストされたとき: true
  • そうでないとき: false

解説

この関数は、 URL のスキームに関連付けられたアプリに対し、 非同期のイベントとして EVT_APP_POST_URL イベントをポストします。

[Caution] 注意

戻り値は、イベントが正常にイベントキューに追加されたかどうかのみを表します。 イベントが正常に受信側アプリへ送られたことは表しません。

バージョン

この関数は、BREW 3.1 から使用可能です。

参照

BREW API ISHELL_PostURL | SFBShell::PostEvent


SFBShell::Prompt
マルチ選択のプロンプトを表示します。
[ public ]
Bool Prompt(
    AEEPromptInfo* info   // プロンプト情報
);

戻り値

  • ダイアログが作成されるとき: true
  • そうでないとき: false

解説

この関数は、 マルチ選択のプロンプトを表示します。

参照

BREW API ISHELL_Prompt | AEEPromptInfo


SFBShell::QueryClass
指定された ClassID のクラスまたはアプリがサポートされているかどうかを判定します。
[ public ]
Bool QueryClass(
    AEECLSID clsid     // ClassID
    AEEAppInfo* info   // アプリ情報
);

戻り値

  • クラスがサポートされているとき: true
  • そうでないとき: false

解説

この関数は、 指定された ClassID のクラスまたはアプリがサポートされているかどうかを判定します。

[Note] 注意

AEEAppInfo 構造体を渡した場合は、 要求されたクラスが利用可能であってもアプリでなければ false が返されます。

参照

BREW API ISHELL_QueryClass | AEEAppInfo | SFBShell::CreateInstance


SFBShell::RegisterEvent
指定されたイベント名を基に他のユーザーイベントと競合しないイベントを登録します。
[ public ]
AEEEvent RegisterEvent(
    ACharConstPtr name   // イベント名
    SInt32Ptr count      // イベントの登録を試行した回数
);
[ public ]
AEEEvent RegisterEvent(
    SFXAnsiStringConstRef name   // イベント名
    SInt32Ptr count              // イベントを登録した回数
);

戻り値

指定されたイベント名に関連付けられているイベント(AEEEvent)。

イベントを登録できなかった場合、0。

解説

この関数は、 指定されたイベント名を基に他のユーザーイベントと競合しないイベント(AEEEvent)を登録します。

以下の点に注意してください。

  • 登録されたイベントは同じパワーサイクル内でのみ有効です。 次回のパワーサイクルでは、異なるイベントコードを返す可能性があります。
  • 戻り値が 0 である場合、イベントは登録されていません。
  • 以前に登録されたイベントは、同じ値が返されます。
  • count 引数を指定すると、 イベントを登録した回数が返されます。
[Note] 注意

ユーザーイベントとは、EVT_USER 以上のイベントです。

バージョン

この関数は、BREW 3.1 から使用可能です。

参照

BREW API ISHELL_RegisterEvent | AEEEvent


SFBShell::RegisterHandler
指定されたハンドラを AEE シェルに登録します。
[ public ]
SFCError RegisterHandler(
    AEECLSID clsidBase   // ハンドラタイプ、基底クラス
    ACharConstPtr in     // 入力文字列
    AEECLSID clsid       // ハンドラの ClassID
);
[ public ]
SFCError RegisterHandler(
    AEECLSID clsidBase         // ハンドラタイプ、基底クラス
    SFXAnsiStringConstRef in   // 入力文字列
    AEECLSID clsid             // ハンドラの ClassID
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • 引数が不正なとき: SFERR_INVALID_PARAM
  • メモリ不足のとき: SFERR_NO_MEMORY
  • 失敗したとき: SFERR_FAILED
  • ClassID が無効なとき: EBADCLASS
  • ハンドラが既に設定されているとき: EALREADY

解説

この関数は、 指定されたハンドラを AEE シェルに登録します。

[Note] 注意

コンテンツビューアまたはプロトコルエンジンが自らを AEE シェルに登録します。

このメカニズムによりほかのコンポーネントは、 コンテンツまたはプロトコルタイプに問題が発生した場合に機能を共有できます。

ハンドラはクラスにより指定されるため、必要に応じてダイナミックにロードされます。

参照

BREW API ISHELL_RegisterHandler | AEEHandlerType | SFBShell::GetHandler


SFBShell::RegisterNotify
他のクラスから発行される通知を登録します。
[ public ]
SFCError RegisterNotify(
    AEECLSID clsidNotify   // イベント発生時に作成と通知を行うアプリ
    AEECLSID clsidType     // イベントを発行するクラス
    UInt32 mask            // トリガー用イベントマスク
);

引数

clsidNotify

イベント発生時の通知先アプリ。

clsidType

イベントを発行するクラス(通知元クラス): SFBNotifier クラスを継承して実装する必要がある。

mask

イベントマスク: これをゼロに設定すると、コール側が、通知元クラスからの通知すべてから登録解除されます。 マスクは、2 つの 16 ビットのコンポーネントからなっています。 高位 16 ビットは通知値と呼ばれ、下位 16 ビットは通知マスクを呼ばれます。

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • 引数が不正なとき: SFERR_INVALID_PARAM
  • メモリ不足のとき: SFERR_NO_MEMORY
  • ClassID が無効なとき: EBADCLASS
  • 特権がないとき: EPRIVLEVEL
  • 失敗したとき: SFERR_FAILED

解説

この関数は、 他のクラスから発行される通知を登録します。

参照

BREW API ISHELL_RegisterNotify | BREW API INOTIFIER_SetMask | BREW API GET_NOTIFIER_MASK | BREW API GET_NOTIFIER_VAL | AEENotifyFailure | SFBShell::Notify


SFBShell::RegisterSystemCallback
システムイベントに対するコールバックを登録します。
[ public ]
Void RegisterSystemCallback(
    SFXCallbackPtr callback   // コールバック
    SInt32 type               // システムコールバックのタイプ
);

解説

この関数は、 BREW の起動や終了、アプリの終了、モジュールのアンロードなどのシステムイベントに対するコールバックを登録します。

コールバックはクライアント側で割り当てる必要があります。 type 引数に指定できる値は以下のとおりです。

  • AEE_SCB_AEE_INIT: BREW 起動時に呼び出す。
  • AEE_SCB_AEE_EXIT:BREW 終了時に呼び出す。
  • AEE_SCB_LOW_RAM: デバイスの RAM が設定済み閾値より少なくなった時に呼び出す。
  • AEE_SCB_LOW_RAM_CRITICAL: デバイスの RAM が設定済み閾値より少なく、 AEE_SCB_LOW_RAM コールバックが充分な RAM を供給しない時に呼び出す。
  • AEE_SCB_LOW_STORAGE: デバイスのストレージが設定済み閾値より少なくなった場合に呼び出す。
  • AEE_SCB_APP_CLOSED: アプリの終了直前に呼び出す。
  • AEE_SCB_MOD_UNLOAD: モジュールのアンロード直前に呼び出す。

参照

BREW API ISHELL_RegisterSystemCallback | SFXCallback | SFBShell::OnInit | SFBShell::OnLowRAM | SFBShell::OnLowStorage | SFBShell::OnModUnload


SFBShell::Reset
デバイスをリセットします。
[ public ]
SFCError Reset(
    AEEResetType type   // リセットのタイプ
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • 引数が不正であるとき: SFERR_INVALID_PARAM
  • 特権がないとき: EPRIVLEVEL

解説

この関数は、 デバイスをリセットします。

リセットには、ソフトリセットとハードリセットの 2 つのオプションがあります。

ソフトリセットオプションは、BREW を終了し、再初期化します。 BREW 終了時にコール側のアプリは停止します。

ハードリセットオプションは、デバイスの電源を OFF/ON します。

いずれのリセットオプションにおいても、コール側のアプリは自動的に再起動しません。

[Note] 注意

この関数を使用するには、SYSTEM 特権レベルが必要です。

バージョン

この関数は、BREW 3.1 から使用可能です。

参照

BREW API ISHELL_Reset | AEEResetType


SFBShell::Resume
AEE シェルにコールバックを登録します。
[ public ]
Void Resume(
    SFXCallbackPtr callback   // コールバック
);

解説

この関数は、 AEE シェルにコールバックを登録します (コールバックを AEE シェルの待機中操作リストに追加します)。

[Note] 注意

AEE シェルは、次回のイベントループで AEE シェルの待機中操作リストからコールバックを呼び出します。

参照

BREW API ISHELL_Resume | SFXCallback


SFBShell::ResumeAlarms
BREW アラーム機能を再開します。
[ public ]
SFCError ResumeAlarms(Void);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • 充分な特権がないとき: EPRIVLEVEL
  • 失敗したとき: AEEError.h で定義されているエラー値

解説

この関数は、 BREW アラーム機能を再開します。

[Note] 注意

期限が既に過ぎているすべてのアラームのイベントがスケジューリングされます。

バージョン

この関数は、BREW 3.1 から使用可能です。

参照

BREW API ISHELL_ResumeAlarms | SFBShell::SuspendAlarms | SFBShell::SetAlarm | SFBShell::CancelAlarm


SFBShell::SendEvent
指定されたアプリ(またはダイアログ)に指定された同期イベントを送信します。
[ public ]
Bool SendEvent(
    AEECLSID clsid   // イベントを受け取るアプリの ClassID(EVT_USER 以上のイベントには必須)
    AEEEvent event   // AEE イベント
    UInt16 wParam    // イベント固有の 16 ビット値
    UInt32 dwParam   // イベント固有の 32 ビット値
);
[ public ]
Bool SendEvent(
    AEECLSID clsid           // イベントを受け取るアプリの ClassID(EVT_USER 以上のイベントには必須)
    SFXEventConstRef event   // イベント
);

戻り値

  • イベントが処理されたとき: true
  • イベントが処理されなかったとき: false

解説

この関数は、 指定されたアプリ(またはダイアログ)に指定された同期イベントを送信します。

clsid 引数にアプリの ClassID を指定することで、 EVT_USER 以上のユーザーイベントをアプリに送信することが可能です。 ClassID を指定せずに EVT_USER 以上のイベントを送信した場合、イベントの送信は失敗します。

アプリが現在実行されていない場合は、そのアプリがロードされイベントが直接送られます。 この場合は、アプリはバックグラウンドで起動されます (EVT_APP_START および EVT_APP_STOP イベントはアプリに送信されません)。

SFBShell::CreateDialog 関数で作成したダイアログがアクティブである場合、 イベントがアプリに渡される前にそのダイアログに渡されます。 なお、このイベントは、 ダイアログがイベントを処理しない場合にのみアプリに渡されます。

[Note] SFBShell::PostEvent 関数との違い

この関数がアプリに即座にイベントを送信するのに対し、 SFBShell::PostEvent 関数はアプリにイベントをポスト(イベントキューに追加)するだけです。

[Note] イベント固有の 16 / 32 ビット値の検査について

AEE シェルは、イベント固有の 16 / 32 ビット値を検査しません。

[Caution] 非同期イベントについて

EVT_KEY / EVT_KEY_PRESS / EVT_KEY_RELEASE / EVT_PEN_DOWN / EVT_PEN_UP / EVT_PEN_MOVE / EVT_JOYSTICK_POS / EVT_CHAR, EVT_UPDATECHAR イベントは非同期イベントです。

これらのイベントは、この関数を使用しても、非同期にポスト(イベントキューに追加)されるだけです。

使用例

アプリに強制再描画イベントを送信します。

SFBShellSmp         shell = SFBShell::GetInstance();

// アプリに強制再描画イベントを送信する
shell->SendEvent(SFCApplet::GetClassID(), SFXEvent(SREVT_RESPONDER_RENDER, SRP16_RENDER_INVOKE, true));

参照

BREW API ISHELL_SendEvent | AEEEvent | AEECLSID | SFBShell::PostEvent | SFBShell::PostEventEx | SFBShell::CreateDialog


SFBShell::SendURL
URL のスキームに関連付けられたアプリに対し、同期のイベントとして EVT_APP_POST_URL イベントを送ります。
[ public ]
Bool SendURL(
    ACharConstPtr url   // URL
);
[ public ]
Bool SendURL(
    SFXAnsiStringConstRef url   // URL
);

戻り値

  • イベントが処理されたとき: true
  • イベントがポストされなかったとき: false

解説

この関数は、 URL のスキームに関連付けられたアプリに対し、同期のイベントとして EVT_APP_POST_URL イベントを送ります。

BREW はアプリに URL を渡す前に、内部に URL をコピーします。

SFBShell::BrowseURL 関数と異なり、 この関数はアプリをアクティブにしません。 この関数は、SFBShell::SendEvent 関数と同じ動作をします。

  • もしアプリがすでにロードされている場合、 EVT_APP_POST_URL イベントはそのインスタンスに渡されます。
  • もしアプリがまだロードされていない場合は、 最初にアプリがメモリにロードされ、その後に EVT_APP_POST_URL イベントはそのインスタンスに渡されます。

EVT_APP_POST_URL イベントを受信したアプリをフォアグラウンドで処理した場合は、 自分自身に対して SFBShell::StartApplet 関数を呼び出す必要があります。

EVT_APP_POST_URL イベントを受信したアプリをバックグラウンドで処理したい場合は、 自分自身に対して SFBShell::StartBackgroundApplet 関数を呼び出す必要があります。

バージョン

この関数は、BREW 3.1 から使用可能です。

参照

BREW API ISHELL_PostURL | SFBShell::BrowseURL | SFBShell::StartApplet | SFBShell::StartBackgroundApplet | SFBShell::SendEvent | SFBShell::PostEvent


SFBShell::SetAlarm
アラームをアプリに設定します。
[ public ]
SFCError SetAlarm(
    AEECLSID clsid   // アラームを設定するアプリの ClassID
    UInt16 code      // アプリに渡す 16 ビット値
    UInt32 minutes   // アラームを起動するまでの時間 [単位: 分]
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • 引数が無効であるとき: SFERR_INVALID_PARAM
  • メモリ不足のとき: SFERR_NO_MEMORY

解説

この関数は、 (満了までの時間が長い)アラームをアプリに設定します。

アラームが発生した場合、 clsid 引数に指定したアプリがロードされ、 code 引数に指定した 16 ビット値を持つ EVT_ALARM イベントが渡されます。

このとき、EVT_APP_START イベントは送られません。 アプリをアクティブにするには、SFBShell::StartApplet 関数を呼び出します。

code 引数に 16 ビット値を指定することにより、 1 つのアプリに複数のアラームを設定できます。

参照

BREW API ISHELL_SetAlarm | SFBShell::CancelAlarm | SFBShell::StartApplet | SFBShell::SuspendAlarms | SFBShell::ResumeAlarms


SFBShell::SetAppPrefs
指定されたアプリ固有のプリファレンスが含まれる構造体を設定します。
[ public ]
SFCError SetAppPrefs(
    UInt16 version   // プリファレンスのバージョン
    VoidPtr config   // 格納するプリファレンスデータへのポインタ
    UInt16 size      // 格納するメモリーブロックのサイズ
);
[ public ]
SFCError SetAppPrefs(
    UInt16 version        // プリファレンスのバージョン
    SFXBufferPtr config   // 格納するプリファレンスデータへのバッファ
);

戻り値

常に SFERR_NO_ERROR。

解説

この関数は、 指定されたアプリ固有のプリファレンスが含まれる構造体を設定します。

[Note] 注意

アプリ特有の設定や基本設定を持続的に保存したり取得することができます (この情報はファイルに保存されます)。

基本設定を取得するには、SFBShell::GetAppPrefs 関数を使用します。

参照

BREW API ISHELL_SetAppPrefs | SFBShell::GetAppPrefs


SFBShell::SetPrefs
指定されたアプリ固有のプリファレンスを設定します。
[ public ]
SFCError SetPrefs(
    AEECLSID clsid   // ClassID
    UInt16 version   // バージョン
    VoidPtr config   // プリファレンスデータ
    UInt16 size      // プリファレンスデータのサイズ
);
[ public ]
SFCError SetPrefs(
    AEECLSID clsid        // ClassID
    UInt16 version        // バージョン
    SFXBufferPtr config   // プリファレンスデータ
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • 引数が無効であるとき: SFERR_INVALID_PARAM
  • メモリ不足のとき: SFERR_NO_MEMORY
  • 失敗したとき: SFERR_FAILED

解説

この関数は、 指定されたアプリ固有のプリファレンスを設定します。

参照

BREW API ISHELL_SetPrefs | SFBShell::GetPrefs


SFBShell::SetProperty
指定された Class ID に関連付けられている基本モジュールのプロパティを設定します。
[ public ]
SFCError SetProperty(
    AEECLSID clsid   // 問い合わせるアプリケーションの Class ID
    UInt16 wId       // プロパティ ID
    VoidPtr src      // 読み込み先
    UInt16 size      // バッファのサイズ
);
[ public ]
SFCError SetProperty(
    AEECLSID clsid     // 問い合わせるアプリケーションのクラス
    UInt16 wId         // プロパティ ID
    SFXBufferPtr src   // バッファへのポインタ
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • メモリ不足のとき: SFERR_NO_MEMORY
  • 指定された Class ID が存在しないとき: EBADCLASS
  • 特権がないとき: EPRIVLEVEL

解説

この関数は、 指定された Class ID に関連付けられている基本モジュールのプロパティを設定します。

バージョン

この関数は、BREW 3.1 から使用可能です。

参照

BREW API ISHELL_SetProperty | AEECLSID | SFBShell::GetProperty | SFBShell::ClearProperty


SFBShell::SetTimer
タイマーを設定します。[単位: ミリ秒]
[ public ]
SFCError SetTimer(
    SInt32 mSecs          // タイマーが満了するまでの時間 [単位: ミリ秒]: 現在時間 + mSecs で作動する。負の値は 0 として処理される
    PFNNOTIFY notify      // タイマー満了時に呼び出されるコールバック関数
    VoidPtr data = null   // コールバック関数への唯一のパラメータとして渡されるユーザーデータ
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • メモリ不足のとき: SFERR_NO_MEMORY
  • 引数が無効であるとき: SFERR_INVALID_PARAM

解説

この関数は、タイマーを設定します。[単位: ミリ秒]

タイマーに設定した時間が経過した場合は、指定したコールバック関数が呼び出され、 コールバック関数の第 1 引数として、指定したユーザーデータのポインタが渡されます。

以下の点に注意してください。

  • タイマーは、現在の時間 + 指定したミリ秒で作動します。
  • タイマーのコールバックが行われるのは、アプリがタスクを処理しているときです。 非タスクコールバックはシステムが管理するため、開発者がこの作業に関与することはありません。
  • 通常の処理はすべてコールバックで行えます。通常の処理とは、画面への描画、ファイルへの書き込みなどです。
  • タイマーの作動は 1 回だけです。ユーザーは、タイマーを繰り返すにはタイマーをリセットする必要があります。
  • 待機中のタイマーは、同じコールバックポインタまたはデータポインタが指定されると、指定されたタイマーで上書きされます。
  • 現在アクティブなアプリが終了する際、 シェルはタイマーリストをスキャンします。 アプリが、終了により削除された(すなわち、参照カウントが 0 になった)後に、 関連付けられたタイマーが BREW API IApplet を指すデータポインタにより検出された場合は、このタイマーは削除されます。
  • 負のタイムアウト値は、タイムアウト値が 0 の場合と同様に処理されます。

使用例

タイマーを使用して四角形を右方向に移動します。

#define TIMER_VAL   100

// シェイプクラスのクラス定義
SFMTYPEDEFCLASS(Shape)
class Shape :public SFRApplication
{
private:
    SFXRectangle    _rect;

public:
    static SFCInvokerPtr ructorConst() { return new Shape; }
private:
    Shape::Shape()
    {
        SFBShellSmp shell = SFBShell::GetInstance();

        // 描画ハンドラを登録する
        RegisterHandler(SREVT_RESPONDER_RENDER, SRP16_RENDER_CONTENT, HANDLER_BEFORE, OnDrawEntry, this);

        // タイマーを設定する
        shell->SetTimer(TIMER_VAL, OnTimerEntry, this);

        // 四角形を初期化する
        _rect.Set(0, 0, 32, 32);
    }

    // 描画ハンドラ
    Void OnDraw(SFXGraphicsPtr);
    static Bool OnDrawEntry(SFXEventConstRef event, VoidPtr data)
    {
        ShapePtr(data)->OnDraw(SFXGraphicsPtr(event.P32()));
        return true;
    }

    // タイマーハンドラ
    Void OnTimer(Void);
    static Void OnTimerEntry(VoidPtr data)
    {
        ShapePtr(data)->OnTimer();
    }
};

//
// タイマーで呼び出される関数
//
Void Shape::OnTimer(Void)
{
    SFBShellSmp     shell = SFBShell::GetInstance();

    // 四角形を右方向へ 3 移動する
    _rect.Offset(3, 0);

    // アプリに強制再描画イベントをポストする
    shell->PostEvent(SFCApplet::GetClassID(), SFXEvent(SREVT_RESPONDER_RENDER, SRP16_RENDER_INVOKE, true));

    // 再度タイマーを設定する
    shell->SetTimer(TIMER_VAL, OnTimerEntry, this);
}

//
//    描画ハンドラ
//
Void Shape::OnDraw(SFXGraphicsPtr g)
{

    SFBShellSmp   shell = SFBShell::GetInstance();

    // 背景を白色で塗りつぶす
    g->SetBackground(SFXRGBColor(255, 255, 255));
    g->ClearRect(GetContentWorld());

    // 赤色で塗り潰した四角形を描画する
    g->SetFillMode(true);
    g->SetFillColor(SFXRGBColor(255, 0, 0));
    g->DrawRect(_rect);
}

参照

BREW API ISHELL_SetTimer | BREW API IApplet | PFNNOTIFY | SFBShell::GetTimerExpiration | SFBShell::CancelTimer


SFBShell::SetTimerEx
コールバック構造体を使用してタイマーを設定します。 [単位: ミリ秒]
[ public ]
SFCError SetTimerEx(
    SInt32 mSecs              // タイマーが満了するまでの時間 [単位: ミリ秒]: 現在時間 + mSecs で作動する。負の値は 0 として処理される
    SFXCallbackPtr callback   // コールバック構造体のポインタ
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • メモリ不足のとき: SFERR_NO_MEMORY
  • callback 引数が null または無効であるとき: SFERR_INVALID_PARAM

解説

この関数は、 コールバック構造体を使用してタイマーを設定します。[単位: ミリ秒]

タイマーに設定した時間が経過した場合は、指定したコールバック関数が呼び出され、 コールバック関数の第 1 引数として、指定したユーザーデータのポインタが渡されます。

以下の点に注意してください。

  • タイマーは、現在の時間 + 指定したミリ秒で作動します。
  • タイマーのコールバックが行われるのは、アプリがタスクを処理しているときです。 非タスクコールバックはシステムが管理するため、開発者がこの作業に関与することはありません。
  • 通常の処理はすべてコールバックで行えます。通常の処理とは、画面への描画、ファイルへの書き込みなどです。
  • タイマーの作動は 1 回だけです。ユーザーは、タイマーを繰り返すにはタイマーをリセットする必要があります。
  • 待機中のタイマーは、同じコールバックポインタまたはデータポインタが指定されると、指定されたタイマーで上書きされます。
  • 現在アクティブなアプリが終了する際、 シェルはタイマーリストをスキャンします。 アプリが、終了により削除された(すなわち、参照カウントが 0 になった)後に、 関連付けられたタイマーが BREW API IApplet を指すデータポインタにより検出された場合は、このタイマーは削除されます。
  • 負のタイムアウト値は、タイムアウト値が 0 の場合と同様に処理されます。

使用例

タイマーを使用して四角形を右方向に移動します。

#define TIMER_VAL   100

// シェイプクラスのクラス定義
SFMTYPEDEFCLASS(Shape)
class Shape : public SFRApplication
{
private:
    SFXRectangle      _rect;
    SFXCallback   _callback;

public:
    static SFCInvokerPtr ructorConst() { return new Shape; }
private:
    Shape::Shape()
    {
        SFBShellSmp shell = SFBShell::GetInstance();

        // 描画ハンドラを登録する
        RegisterHandler(SREVT_RESPONDER_RENDER, SRP16_RENDER_CONTENT, HANDLER_BEFORE, OnDrawEntry, this);

        // タイマーを設定する
        shell->SetTimerEx(TIMER_VAL, &_callback);

        // 四角形を初期化する
        _rect.Set(0, 0, 32, 32);
    }

    // 描画ハンドラ
    Void OnDraw(SFXGraphicsPtr);
    static Bool OnDrawEntry(SFXEventConstRef event, VoidPtr data)
    {
        ShapePtr(data)->OnDraw(SFXGraphicsPtr(event.P32()));
        return true;
    }

    // タイマーハンドラ
    Void OnTimer(Void);
    static Void OnTimerEntry(VoidPtr data)
    {
        ShapePtr(data)->OnTimer();
    }
};

//
// タイマーで呼び出される関数
//
Void Shape::OnTimer(Void)
{
    SFBShellSmp  shell = SFBShell::GetInstance();

    // 四角形を右方向へ 3 移動する
    _rect.Offset(3, 0);

    // アプリに強制再描画イベントをポストする
    shell->PostEvent(SFCApplet::GetClassID(), SFXEvent(SREVT_RESPONDER_RENDER, SRP16_RENDER_INVOKE, true));

    // 再度タイマーを設定する
    shell->SetTimerEx(TIMER_VAL, &_callback);
}

//
//    描画ハンドラ
//
Void Shape::OnDraw(SFXGraphicsPtr g)
{

    SFBShellSmp   shell = SFBShell::GetInstance();

    // 背景を白色で塗りつぶす
    g->SetBackground(SFXRGBColor(255, 255, 255));
    g->ClearRect(GetContentWorld());

    // 赤色で塗り潰した四角形を描画する
    g->SetFillMode(true);
    g->SetFillColor(SFXRGBColor(255, 0, 0));
    g->DrawRect(_rect);
}

参照

BREW API ISHELL_SetTimerEx | AEECallback | SFBShell::SetTimer | SFBShell::CancelTimer


SFBShell::ShowCopyright
アプリの著作権情報を表示します。
[ public ]
Bool ShowCopyright(Void);

戻り値

  • 著作権情報が正常に表示されたとき: true
  • 著作権情報が正常に表示されなかったとき: false

参照

BREW API ISHELL_ShowCopyright


SFBShell::StartApplet
指定されたアプリをフォアグラウンドで起動します。
[ public ]
SFCError StartApplet(
    AEECLSID clsid   // 起動するアプリの ClassID
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • メモリ不足のとき: SFERR_NO_MEMORY
  • 指定したクラスがサポートされていないとき: SFERR_CLASS_UNSUPPORTED
  • 他のアプリが既に起動しているとき: EALREADY
  • このシェルが無効なとき: EBADCLASS
  • 指定したアプリが既に終了していたとき: EEXPIRED
  • 指定したアプリが最後に実行したときに正常に終了しなかったとき: EBADSHUTDOWN
  • 指定したアプリが無効にされているとき: EFILENOEXISTS
  • OEM 層がアプリのロードを拒否したとき: EUNABLETOLOAD
  • 指定したアプリが異なる SIM カードからダウンロードされたとき: EBADSID
  • 現在前面に表示されているアプリがコントロールを開放しないとき: EITEMBUSY

解説

この関数は、 指定されたアプリをフォアグラウンドで起動します。

要求されたアプリがサポートされていて起動可能な場合は、 AEE シェルはアプリをロードしてそれを起動します。 この関数呼び出しはアプリの起動前に即座に呼び出し側に戻ることに注意してください。

アプリは非同期で起動されるため、 指定されたアプリの ClassID が見つからなかった場合は、 この関数の戻り値が SFERR_NO_ERROR であってもアプリは起動しません。

起動されたアプリは、 EVT_APP_START または EVT_APP_RESUME イベントを受信します (このとき、32 ビット値として AEEAppStart 構造体へのポインタが渡されます)。

他のアプリによりアプリが起動された場合は、 現在アクティブなアプリはサスペンドされた状態になります。

[Note] 注意

この関数は、非同期の関数です。 新しいアプリは、コントロールがシステムに開放されるまで起動されません。

この関数により、 新しいアプリが起動する直前に、 現在アクティブなアプリは EVT_APP_SUSPEND イベントを受け取ります。

アプリが最後に実行されたときに正常に終了しなかった場合は、 EBADSHUTDOWN が返ります。

使用例

指定した ClassID のアプリ(サンプル アプリ)を起動します。

SFBShellSmp shell = SFBShell::GetInstance();

// アプリを起動する
shell->StartApplet(AEECLSID_SAMPLEAPPLET);

参照

BREW API ISHELL_StartApplet | AEECLSID | AEEAppStart | SFBShell::CreateInstance | SFBShell::CanStartApplet | SFBShell::CloseApplet | SFBShell::ActiveApplet | SFBShell::BrowseURL | SFBShell::SendURL


SFBShell::StartAppletArgs
指定されたアプリを起動し、コマンドライン引数を渡します。
[ public ]
SFCError StartAppletArgs(
    AEECLSID clsid       // アプリの ClassID
    ACharConstPtr args   // アプリに渡す ASCII 文字列
);
[ public ]
SFCError StartAppletArgs(
    AEECLSID clsid               // アプリの ClassID
    SFXAnsiStringConstRef args   // アプリに渡す ASCII 文字列
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • メモリ不足のとき: SFERR_NO_MEMORY
  • 指定したクラスがサポートされていないとき: SFERR_CLASS_UNSUPPORTED
  • 他のアプリが既に起動しているとき: EALREADY
  • このシェルが無効なとき: EBADCLASS
  • 指定したアプリが終了したとき: EEXPIRED
  • 指定したアプリが無効にされているとき: EFILENOEXISTS
  • OEM または現在のアプリのためにこのアプリをロードできないとき: EUNABLETOLOAD
  • 現在前面に表示されているアプリがコントロールを開放しないとき: EITEMBUSY

解説

この関数は、 指定されたアプリを起動し、コマンドライン引数を渡します。

参照

BREW API ISHELL_StartAppletArgs | AEECLSID | SFBShell::CreateInstance | SFBShell::StartAppletEx | SFBShell::StartBackgroundApplet | SFBShell::BrowseFile | SFBShell::BrowseURL


SFBShell::StartAppletEx
指定されたフラグの内容で指定されたアプリをフォアグラウンドで起動します。
[ public ]
SFCError StartAppletEx(
    AEECLSID clsid   // 起動するアプリの ClassID
    UInt16 flags     // 動作フラグ
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • メモリ不足のとき: SFERR_NO_MEMORY
  • 指定したクラスがサポートされていないとき: SFERR_CLASS_UNSUPPORTED
  • 他のアプリが既に起動しているとき: EALREADY
  • 指定したシェルクラスが無効なとき: EBADCLASS
  • 指定したアプリが既に終了していたとき: EEXPIRED
  • 履歴に既に存在するアプリを起動するために、フラグ SSA_BACKGROUND が渡されたとき: ENOTALLOWED
  • 指定したアプリが無効にされているとき: EFILENOEXISTS
  • OEM または現在のアプリが指定したアプリのロードを許可しないとき: EUNABLETOLOAD
  • 現在前面に表示されているアプリがコントロールを開放しないとき: EITEMBUSY

解説

この関数は、 指定されたフラグの内容で指定されたアプリをフォアグラウンドで起動します。

以下の点を除き、SFBShell::StartApplet 関数と同様に機能します。

  1. SSA_NO_VOICE_CALL フラグを指定した場合、音声通話の間アプリは起動しません。
  2. SSA_AFTER_VOICE_CALL フラグを指定した場合、現在の音声通話が終了し、 OEM 定義の通話終了ダイアログが閉じた後でアプリが起動します。
  3. SSA_CONFIG フラグを指定した場合、 アプリは EVT_APP_CONFIG イベントで起動します。
  4. SSA_HIDDEN_CONFIG フラグを指定した場合、 アプリは EVT_APP_HIDDEN_CONFIG イベントで起動します。
  5. SSA_BACKGROUND フラグが指定されている場合、アプリはバックグラウンドで起動します。 このフラグは、履歴に既に存在するアプリに対しては、指定できません。 指定すると、ENOTALLOWED が返されます。
[Note] 注意

SSA_CONFIG と SSA_HIDDEN_CONFIG どちらのフラグも指定しなかった場合、 アプリは標準の EVT_APP_START イベントで起動することに注意してください。

使用例

SSA_CONFIG フラグを指定して ClassID が AEECLSID_SAMPLEAPPLET であるアプリ(サンプル アプリ)を起動します。 アプリは、起動時に EVT_APP_START の代わりに EVT_APP_CONFIG イベントを受信します。

SFBShellSmp shell = SFBShell::GetInstance();

// アプリを起動する
// SSA_CONFIG フラグを指定した場合、
// アプリは EVT_APP_CONFIG イベントで起動する
shell->StartAppletEx(AEECLSID_SAMPLEAPPLET, SSA_CONFIG);

参照

BREW API ISHELL_StartAppletEx | AEECLSID | SFBShell::StartApplet | SFBShell::BrowseFile | SFBShell::BrowseURL | SFBShell::SendURL


SFBShell::StartBackgroundApplet
指定されたアプリをバックグラウンドで起動します。
[ public ]
SFCError StartBackgroundApplet(
    AEECLSID clsid       // アプリの ClassID
    ACharConstPtr args   // アプリに渡す ASCII 文字列
);
[ public ]
SFCError StartBackgroundApplet(
    AEECLSID clsid               // アプリの ClassID
    SFXAnsiStringConstRef args   // アプリに渡す ASCII 文字列
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • メモリ不足のとき: SFERR_NO_MEMORY
  • 指定したクラスがサポートされていないとき: SFERR_CLASS_UNSUPPORTED
  • 他のアプリが既に起動しているとき: EALREADY
  • このシェルが無効なとき: EBADCLASS
  • 指定したアプリが既に終了していたとき: EEXPIRED
  • 指定したアプリが無効にされているとき: EFILENOEXISTS
  • OEM がこのアプリのロードを許可しないとき: EUNABLETOLOAD
  • 既に履歴にあるため、バックグラウンドで起動できないとき: ENOTALLOWED

解説

この関数は、 指定されたアプリをバックグラウンドで起動します。

指定されたアプリが既に起動されており、現在履歴に存在する場合は、 ENOTALLOWED が返されます。

[Note] 注意

指定したアプリがバックグラウンドで起動する点を除き、 SFBShell::StartAppletArgs 関数と同じです。

起動されたアプリは、EVT_APP_START イベントの変わりに EVT_APP_START_BACKGROUND イベントを受信します。

バージョン

この関数は、BREW 3.1 から使用可能です。

参照

BREW API ISHELL_StartBackgroundApplet | AEECLSID | SFBShell::CreateInstance | SFBShell::StartAppletArgs | SFBShell::StartAppletEx | SFBShell::BrowseFile | SFBShell::BrowseURL | SFBShell::SendURL


SFBShell::SuspendAlarms
BREW アラーム機能を一時停止します。
[ public ]
SFCError SuspendAlarms(Void);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • 充分な特権がないとき: EPRIVLEVEL
  • 失敗したとき: AEEError.h で定義されているエラー値

解説

この関数は、 BREW アラームサブシステムの操作を一時停止します。

[Note] 注意

この関数は、アラームをスケジュールするアプリの機能には影響を与えません。

単に、SFBShell::ResumeAlarms 関数が呼び出されるまで、 または電話がリセットされるまでアラーム通知を延期するだけです。

バージョン

この関数は、BREW 3.1 から使用可能です。

参照

BREW API ISHELL_SuspendAlarms | SFBShell::ResumeAlarms | SFBShell::SetAlarm | SFBShell::CancelAlarm


SFBShell::UnregisterHandler
ハンドラの登録を解除します。
[ public ]
SFCError UnregisterHandler(
    SFXAnsiStringConstRef in   // 入力文字列
);

戻り値

  • 成功したとき: SFERR_NO_ERROR
  • 引数が不正なとき: SFERR_INVALID_PARAM
  • メモリ不足のとき: SFERR_NO_MEMORY
  • 失敗したとき: SFERR_FAILED
  • ClassID が無効なとき: EBADCLASS
  • ハンドラが既に設定されているとき: EALREADY

解説

この関数は、ハンドラの登録を解除します。

参照

BREW API ISHELL_RegisterHandler | SFBShell::RegisterHandler