PrevNextUpHome SophiaFramework UNIVERSE 5.3
SFBShell
Wrapper Class for the IShell interface.
#include <SFBShell.h.hpp>
class SFBShell : public SFBBase;
SFMTYPEDEFWRAPPER(SFBShell)

Inheritance diagram

 Inheritance diagram of SFBShellClass

Version

BREW 2.0 BREW 2.1 BREW 3.1 BREW 4.0
O O O O

Reference

BREW API IShell

Member

Public Functions
AEECLSID ActiveApplet( Void )
Return the AEECLSID associated with the currently top visible applet.
Bool AlarmsActive( Void )
Return true if an alarm is set for the calling applet.
SFCError AppIsInGroup( AEECLSID idApp , AEECLSID idGroup )
Check the specified application class id for membership with the specified group.
Bool Beep( BeepType beep , Bool loud = false )
Provide a simple interface to play system beeps or vibrate the device.
Void BrowseFile( ACharConstPtr file )
This method instructs the AEE to start the applet associated with the file type specified (by extension).
Void BrowseFile( SFXAnsiStringConstRef file )
This method instructs the AEE to start the applet associated with the file type specified (by extension).
Void BrowseURL( ACharConstPtr url )
This method instructs the AEE to start the applet associated with the URL scheme specified.
Void BrowseURL( SFXAnsiStringConstRef url )
This method instructs the AEE to start the applet associated with the URL scheme specified.
Bool Busy( Void )
Return true if the applet must exit.
Bool CanStartApplet( AEECLSID clsid )
Query the AEE Shell to determine whether it is safe to start an applet.
SFCError CancelAlarm( AEECLSID clsid , UInt16 userCode )
Cancel an alarm set through SFBShell::SetAlarm().
SFCError CancelTimer( PFNNOTIFY notify = null , VoidPtr data = null )
Cancel a timer that has been set by SFBShell::SetTimer().
Bool CheckPrivLevel( AEECLSID privilege , Bool queryOnly = true )
Check the privilege level of the currently running application against the specified value.
SFCError ClearProperty( AEECLSID clsid , UInt16 wId )
CLear the property data of the basic module that related to input class.
SFCError ClearShutdownErrors( Void )
Clear the error status of all the applications.
SFCError CloseApplet( Bool returnToIdle = false )
Instruct the AEE Shell to close the active applet.
SFCError CreateDialog( ACharConstPtr resFile , UInt16 id )
Instruct the AEE Shell to start a dialog associate with the input DialogInfo data structure or the dialog information in the associated resource file.
SFCError CreateDialog( DialogInfo* info )
Instruct the AEE Shell to start a dialog associate with the input DialogInfo data structure or the dialog information in the associated resource file.
SFCError CreateDialog( SFXAnsiStringConstRef resFile , UInt16 id )
Instruct the AEE Shell to start a dialog associate with the input DialogInfo data structure or the dialog information in the associated resource file.
SFCError CreateInstance( AEECLSID clsid , SFBBaseSmpPtr handle )
Create an object associated with the specified 32-bit ClassID.
SFBBaseSmp CreateInstance( AEECLSID clsid )
Create an object associated with the specified 32-bit ClassID.
SFCError DetectType( VoidConstPtr data , UInt32Ptr size , ACharConstPtr name , ACharConstHandle mime )
Given data in a buffer or the name of an object, this function detects the MIME type.
SFCError DetectType( SFXBufferConstRef data , UInt32Ptr additional , ACharConstPtr name , ACharConstHandle mime )
Given data in a buffer or the name of an object, this function detects the MIME type.
SFCError DetectType( VoidConstPtr data , UInt32Ptr size , SFXAnsiStringConstRef name , SFXAnsiStringPtr mime )
Given data in a buffer or the name of an object, this function detects the MIME type.
SFCError DetectType( SFXBufferConstRef data , UInt32Ptr additional , SFXAnsiStringConstRef name , SFXAnsiStringPtr mime )
Given data in a buffer or the name of an object, this function detects the MIME type.
SFCError DetectType( VoidConstPtr data , UInt32Ptr size , SFXAnsiStringPtr mime )
Given data in a buffer or the name of an object, this function detects the MIME type.
SFCError DetectType( SFXBufferConstRef data , UInt32Ptr additional , SFXAnsiStringPtr mime )
Given data in a buffer or the name of an object, this function detects the MIME type.
SFCError EndDialog( Void )
This function closes the currently active dialog.
Void EnumAppletInit( Void )
Reset the AEE Shell’s internal applet enumeration index.
AEECLSID EnumNextApplet( AEEAppInfo* info )
Return information about the next applet.
Bool ForceExit( Void )
Return true if the applet must exit.
Void FreeResData( VoidPtr data )
Free the data previously returned by SFBShell::LoadResData().
SFBDialogSmp GetActiveDialog( Void )
Return the current active dialog.
SInt32 GetAppAuthor( WCharPtr buf , SInt32 size )
Get the name of the author of the active applet.
SInt32 GetAppAuthor( SFXWideStringPtr string )
Get the name of the author of the active applet.
SInt32 GetAppCopyright( WCharPtr buf , SInt32 size )
Get the copyright string of the active applet.
SInt32 GetAppCopyright( SFXWideStringPtr string )
Get the copyright string of the active applet.
SInt32 GetAppPrefs( UInt16 version , VoidPtr buf , UInt16 size )
Get the structure containing applet preferences.
SInt32 GetAppPrefs( UInt16 version , SFXBufferPtr buf )
Get the structure containing applet preferences.
SInt32 GetAppVersion( WCharPtr buf , SInt32 size )
Get the version string of the active applet.
SInt32 GetAppVersion( SFXWideStringPtr string )
Get the version string of the active applet.
UInt32 GetClassItemID( AEECLSID clsid )
Get a 32-bit unique identifier associated with the owning module for the specified class ID.
Void GetDeviceInfo( AEEDeviceInfo* info )
Get the AEE Shell for information about the capabilities of the device, such as the amount of supported RAM, the screen display, and other items.
SFCError GetDeviceInfoEx( AEEDeviceItem item , VoidPtr info , SInt32Ptr size )
Get specific information about the device. This function takes an ID that specifies what information is needed. The buffer contains the corresponding information on return.
SFCError GetDeviceInfoEx( AEEDeviceItem item , SFXBufferPtr info )
Get specific information about the device. This function takes an ID that specifies what information is needed. The buffer contains the corresponding information on return.
AEECLSID GetHandler( AEECLSID type , ACharConstPtr in )
Provide query access to the AEE Shell’s database of registered content viewers and protocol scheme handlers.
AEECLSID GetHandler( AEECLSID type , SFXAnsiStringConstRef in )
Provide query access to the AEE Shell’s database of registered content viewers and protocol scheme handlers.
static
SFBShellSmp
GetInstance( Void )
Get the SFBShell instance.
Void GetItemStyle( AEEItemType type , AEEItemStyle* normal , AEEItemStyle* selected )
Get the AEE Shell for information about the default style for menu, icon, or list items.
Void GetJulianDate( UInt32 seconds , JulianType* date )
Get a JulianType data structure based on the input second value.
SInt32 GetPrefs( AEECLSID clsid , UInt16 version , VoidPtr config , UInt16 size )
Get the structure containing applet or class level preferences.
SInt32 GetPrefs( AEECLSID clsid , UInt16 version , SFXBufferPtr config )
Get the structure containing applet or class level preferences.
SFCError GetProperty( AEECLSID clsid , UInt16 wId , VoidPtr dest , UInt16Ptr size )
Retrieve the property data for the underlying module associated with the input class.
SFCError GetProperty( AEECLSID clsid , UInt16 wId , SFXBufferPtr dest )
Retrieve the property data for the underlying module associated with the input class.
UInt32 GetResSize( ACharConstPtr file , UInt16 id , ResType type , UInt32Ptr size )
Get the size of the found resource, or 0 if the resource is not found. A wrapper for SFBShell::LoadResDataEx().
UInt32 GetResSize( SFXAnsiStringConstRef file , UInt16 id , ResType type , UInt32Ptr size )
Get the size of the found resource, or 0 if the resource is not found. A wrapper for SFBShell::LoadResDataEx().
UInt32 GetTimeMS( Void )
Get the current time of day in milliseconds.
UInt32 GetTimerExpiration( PFNNOTIFY notify , VoidPtr data = null )
Get the remaining time in milliseconds before the timer associated with the device user callback/data expires.
UInt32 GetUpTimeMS( Void )
Get the millisecond elapsed since the time the device was powered on.
Bool HandleEvent( AEEEvent event , UInt16 wParam , UInt32 dwParam )
Send one of the specified standard AEEEvent items to the currently active applet.
Bool HandleEvent( SFXEventConstRef event )
Send one of the specified standard AEEEvent items to the currently active applet.
Bool IsValidResource( ACharConstPtr file , UInt16 id , ResType resType , AEEHandlerType handlerType )
Check to see if the specified resource file entry is valid for the type specified.
Bool IsValidResource( SFXAnsiStringConstRef file , UInt16 id , ResType resType , AEEHandlerType handlerType )
Check to see if the specified resource file entry is valid for the type specified.
SFBBitmapSmp LoadBitmap( ACharConstPtr file )
Load an bitmap file directly and returns the SFBBitmap interface for the bitmap.
SFBBitmapSmp LoadBitmap( SFXAnsiStringConstRef file )
Load an bitmap file directly and returns the SFBBitmap interface for the bitmap.
SFBImageSmp LoadBusyImage( Void )
This method loads the image used for indicating that BREW is busy.
SFBImageSmp LoadImage( ACharConstPtr file )
Load an image directly from a file and returns a pointer to an SFBImage interface that can be used to display the image.
SFBImageSmp LoadImage( SFXAnsiStringConstRef file )
Load an image directly from a file and returns a pointer to an SFBImage interface that can be used to display the image.
SFBBitmapSmp LoadResBitmap( ACharConstPtr resFile , UInt16 id )
Load a bitmap resource from the given resource file and returns a valid SFBBitmap interface pointer.
SFBBitmapSmp LoadResBitmap( SFXAnsiStringConstRef resFile , UInt16 id )
Load a bitmap resource from the given resource file and returns a valid SFBBitmap interface pointer.
VoidPtr LoadResData( ACharConstPtr resFile , UInt16 id , ResType type )
Return a void * data block associated with the specified resource file, ID, and type.
VoidPtr LoadResData( SFXAnsiStringConstRef resFile , UInt16 id , ResType type )
Return a void * data block associated with the specified resource file, ID, and type.
VoidPtr LoadResDataEx( ACharConstPtr resFile , UInt16 id , ResType type , VoidPtr buf , UInt32Ptr size )
Attempt to load the resource specified by type and ID from the specified resource context. The function either allocates memory or loads into a pre-allocated buffer.
VoidPtr LoadResDataEx( SFXAnsiStringConstRef resFile , UInt16 id , ResType type , VoidPtr buf , UInt32Ptr size )
Attempt to load the resource specified by type and ID from the specified resource context. The function either allocates memory or loads into a pre-allocated buffer.
VoidPtr LoadResDataEx( SFXAnsiStringConstRef resFile , UInt16 id , ResType type , SFXBufferPtr buf )
Attempt to load the resource specified by type and ID from the specified resource context. The function either allocates memory or loads into a pre-allocated buffer.
SFBImageSmp LoadResImage( ACharConstPtr resFile , UInt16 id )
Load a bitmap resource from the given resource file and returns a valid SFBImage Interface pointer. This pointer can then be used for viewing the image.
SFBImageSmp LoadResImage( SFXAnsiStringConstRef resFile , UInt16 id )
Load a bitmap resource from the given resource file and returns a valid SFBImage Interface pointer. This pointer can then be used for viewing the image.
SFBBaseSmp LoadResObject( ACharConstPtr resFile , UInt16 id , AEECLSID clsidBase )
Load the specified resource and creates a handler that can be used on the resource data.
SFBBaseSmp LoadResObject( SFXAnsiStringConstRef resFile , UInt16 id , AEECLSID clsidBase )
Load the specified resource and creates a handler that can be used on the resource data.
SFBSoundPlayerSmp LoadResSound( ACharConstPtr resFile , UInt16 id )
Load a sound file from the file system and returns the SFBSoundPlayer Interface object for the file when the sound data is included in a resource file as a raw stream of bytes.
SFBSoundPlayerSmp LoadResSound( SFXAnsiStringConstRef resFile , UInt16 id )
Load a sound file from the file system and returns the SFBSoundPlayer Interface object for the file when the sound data is included in a resource file as a raw stream of bytes.
SInt32 LoadResString( ACharConstPtr resFile , UInt16 id , WCharPtr buf , SInt32 size )
Load UNICODE or ISOLATIN strings stored in the specified resource file.
SFXWideString LoadResString( SFXAnsiStringConstRef resFile , UInt16 id )
Load UNICODE or ISOLATIN strings stored in the specified resource file.
SInt32 LoadResString( ACharConstPtr resFile , UInt16 id , SFXWideStringPtr string )
Load UNICODE or ISOLATIN strings stored in the specified resource file.
SInt32 LoadResString( SFXAnsiStringConstRef resFile , UInt16 id , SFXWideStringPtr string )
Load UNICODE or ISOLATIN strings stored in the specified resource file.
SFBSoundPlayerSmp LoadSound( ACharConstPtr resFile )
Load a sound file from the file system and returns the SFBSoundPlayer Interface object for the file.
SFBSoundPlayerSmp LoadSound( SFXAnsiStringConstRef resFile )
Load a sound file from the file system and returns the SFBSoundPlayer Interface object for the file.
Bool MessageBox( ACharConstPtr resFile , UInt16 titleId , UInt16 textId )
Instruct the AEE Shell to display a message box to the device user. A message box is a simple window with a title and text.
Bool MessageBox( SFXAnsiStringConstRef resFile , UInt16 titleId , UInt16 textId )
Instruct the AEE Shell to display a message box to the device user. A message box is a simple window with a title and text.
Bool MessageBoxText( WCharConstPtr title , WCharConstPtr text )
Instruct the AEE Shell to display a message box to the device user. A message box is a simple window with a title and text.
Bool MessageBoxText( SFXWideStringConstRef title , SFXWideStringConstRef text )
Instruct the AEE Shell to display a message box to the device user. A message box is a simple window with a title and text.
SFCError Notify( AEECLSID clsid , UInt32 mask , VoidPtr data )
This function is called by an object when it detects an event that may be associated with a notification requested by another class of object.
Void OnAppClose( SFXCallbackPtr callback )
Enable an applet to register a system callback that gets called when applet closes.
Void OnAppExit( SFXCallbackPtr callback )
Enable an applet to register a callback that gets called after applet destructor is executed.
Void OnExit( SFXCallbackPtr callback )
Enable an applet to register a system callback that gets called when BREW exits.
Void OnInit( SFXCallbackPtr callback )
Enable an applet to register a system callback that gets called when BREW initializes.
Void OnLowRAM( SFXCallbackPtr callback )
Register for the callback to be invoked when the system reaches low memory condition.
Void OnLowRAMCritical( SFXCallbackPtr callback )
Register for the callback to be invoked when the system reaches low memory condition.
Void OnLowStorage( SFXCallbackPtr callback )
Register for the callback to be invoked when the system reaches low file-system space condition.
Void OnModUnload( SFXCallbackPtr callback )
Register a callback to be called when the module is about to be unloaded.
Bool PostEvent( AEECLSID clsid , AEEEvent event , UInt16 wValue , UInt32 dwValue )
Post an asynchronous event to the specified applet.
Bool PostEvent( AEECLSID clsid , SFXEventConstRef event )
Post an asynchronous event to the specified applet.
Bool PostEventEx( UInt16 flags , AEECLSID clsid , AEEEvent event , UInt16 wValue , UInt32 dwValue )
Post an asynchronous event to the specified app.
Bool PostEventEx( UInt16 flags , AEECLSID clsid , SFXEventConstRef event )
Post an asynchronous event to the specified app.
Bool PostURL( ACharConstPtr url )
Post an asynchronous event, EVT_APP_POST_URL, to the applet associated with the URL's scheme.
Bool Prompt( AEEPromptInfo* info )
Provide a mechanism for an application to display a multi selection prompt.
Bool QueryClass( AEECLSID clsid , AEEAppInfo* info )
Query the AEE Shell to determine if the specified class or applet is supported.
AEEEvent RegisterEvent( ACharConstPtr name , SInt32Ptr count )
Register a custom AEEEvent based upon the input string.
AEEEvent RegisterEvent( SFXAnsiStringConstRef name , SInt32Ptr count )
Register a custom AEEEvent based upon the input string.
SFCError RegisterHandler( AEECLSID clsidBase , ACharConstPtr in , AEECLSID clsid )
Provide a mechanism for a content viewer or protocol engine to register itself with the AEE Shell.
SFCError RegisterHandler( AEECLSID clsidBase , SFXAnsiStringConstRef in , AEECLSID clsid )
Provide a mechanism for a content viewer or protocol engine to register itself with the AEE Shell.
SFCError RegisterNotify( AEECLSID clsidNotify , AEECLSID clsidType , UInt32 mask )
Register for notifications that are issued from other classes.
Void RegisterSystemCallback( SFXCallbackPtr callback , SInt32 type )
Register callbacks for important system events like: when BREW starts-up, when application exits, when mod is unloaded, etc.
SFCError Reset( AEEResetType type )
Reset the device.
Void Resume( SFXCallbackPtr callback )
Register a callback with the AEE Shell.
SFCError ResumeAlarms( Void )
Resume operation the BREW alarms subsystem.
Bool SendEvent( AEECLSID clsid , AEEEvent event , UInt16 wParam , UInt32 dwParam )
Send the event directly to the destination applet.
Bool SendEvent( AEECLSID clsid , SFXEventConstRef event )
Send the event directly to the destination applet.
Bool SendURL( ACharConstPtr url )
Post a synchronous event, EVT_APP_POST_URL, to the applet associated with the URL's scheme.
Bool SendURL( SFXAnsiStringConstRef url )
Post a synchronous event, EVT_APP_POST_URL, to the applet associated with the URL's scheme.
SFCError SetAlarm( AEECLSID clsid , UInt16 code , UInt32 minutes )
Set a long-term alarm for an applet.
SFCError SetAppPrefs( UInt16 version , VoidPtr config , UInt16 size )
Set the structure containing applet specific preferences.
SFCError SetAppPrefs( UInt16 version , SFXBufferPtr config )
Set the structure containing applet specific preferences.
SFCError SetPrefs( AEECLSID clsid , UInt16 version , VoidPtr config , UInt16 size )
Provide a method for storing a structure containing applet or class level preferences.
SFCError SetPrefs( AEECLSID clsid , UInt16 version , SFXBufferPtr config )
Provide a method for storing a structure containing applet or class level preferences.
SFCError SetProperty( AEECLSID clsid , UInt16 wId , VoidPtr src , UInt16 size )
Set the property data for the underlying module associated with the input class.
SFCError SetProperty( AEECLSID clsid , UInt16 wId , SFXBufferPtr src )
Set the property data for the underlying module associated with the input class.
SFCError SetTimer( SInt32 mSecs , PFNNOTIFY notify , VoidPtr data = null )
Set a short-term timer.
SFCError SetTimerEx( SInt32 mSecs , SFXCallbackPtr callback )
Set a short-term timer.
Bool ShowCopyright( Void )
Display the copyright information about the applet.
SFCError StartApplet( AEECLSID clsid )
Instruct the AEE Shell to start the applet associated with the specified 32-bit ClassID.
SFCError StartAppletArgs( AEECLSID clsid , ACharConstPtr args )
Instruct the AEE to start the applet associated with the specified 32-bit class ID, passing it the arguments.
SFCError StartAppletArgs( AEECLSID clsid , SFXAnsiStringConstRef args )
Instruct the AEE to start the applet associated with the specified 32-bit class ID, passing it the arguments.
SFCError StartAppletEx( AEECLSID clsid , UInt16 flags )
Instruct the AEE to start the applet associated with the specified 32-bit class ID using the flags specified.
SFCError StartBackgroundApplet( AEECLSID clsid , ACharConstPtr args )
Start the applet with specified ClassID. Send the command line argument.
SFCError StartBackgroundApplet( AEECLSID clsid , SFXAnsiStringConstRef args )
Start the applet with specified ClassID. Send the command line argument.
SFCError UnregisterHandler( SFXAnsiStringConstRef in )
Unregister the hander.
Protected Functions
static
SFBBaseSmp
FactoryByCreate( AEECLSID id , SFCErrorPtr exception = null ) (inherits from SFBBase)
Create the instance for the specified ClassID's interface.
static
SFBBaseSmp
FactoryByQuery( SFBQuerySmpConstRef query , AEECLSID id , SFCErrorPtr exception = null ) (inherits from SFBBase)
Create the instance for the specified ClassID's interface using the SFBQuery instance.

SFBShell::ActiveApplet
Return the AEECLSID associated with the currently top visible applet.
[ public ]
AEECLSID ActiveApplet(Void);

Reference

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


SFBShell::AlarmsActive
Return true if an alarm is set for the calling applet.
[ public ]
Bool AlarmsActive(Void);

Reference

BREW API ISHELL_AlarmsActive | SFBDisplay::SetAnnunciators


SFBShell::AppIsInGroup
Check the specified application class id for membership with the specified group.
[ public ]
SFCError AppIsInGroup(
    AEECLSID idApp     // app class id to verify access for
    AEECLSID idGroup   // group ID
);

Return value

  • application supports this privilege level mask: SFERR_NO_ERROR
  • idApp is not a valid application class ID: SFERR_CLASS_UNSUPPORTED
  • application does not support this privilege : EPRIVLEVEL

Version

This function is available in BREW 3.1.

Reference

BREW API ISHELL_AppIsInGroup | BREW API AEE Privilege Levels | SFBShell::CheckPrivLevel


SFBShell::Beep
Provide a simple interface to play system beeps or vibrate the device.
[ public ]
Bool Beep(
    BeepType beep       // type of beep to play
    Bool loud = false   // true if the beep can be played at a higher volume
);

Reference

BREW API ISHELL_Beep | BeepType


SFBShell::BrowseFile
This method instructs the AEE to start the applet associated with the file type specified (by extension).
[ public ]
Void BrowseFile(
    ACharConstPtr file   // file name 
);
[ public ]
Void BrowseFile(
    SFXAnsiStringConstRef file   // file name 
);

Reference

BREW API ISHELL_BrowseFile | SFBShell::RegisterHandler | SFBShell::GetHandler | SFBShell::BrowseURL


SFBShell::BrowseURL
This method instructs the AEE to start the applet associated with the URL scheme specified.
[ public ]
Void BrowseURL(
    ACharConstPtr url   // URL
);
[ public ]
Void BrowseURL(
    SFXAnsiStringConstRef url   // URL
);

Reference

BREW API ISHELL_BrowseURL | SFBShell::RegisterHandler | SFBShell::GetHandler | SFBShell::BrowseFile


SFBShell::Busy
Return true if the applet must exit.
[ public ]
Bool Busy(Void);

Reference

BREW API ISHELL_Busy | SFBShell::ForceExit


SFBShell::CanStartApplet
Query the AEE Shell to determine whether it is safe to start an applet.
[ public ]
Bool CanStartApplet(
    AEECLSID clsid   // ClassID
);

Reference

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


SFBShell::CancelAlarm
Cancel an alarm set through SFBShell::SetAlarm().
[ public ]
SFCError CancelAlarm(
    AEECLSID clsid    // applet ClassID of alarm to cancel
    UInt16 userCode   // 16-bit use code of alarm to cancel
);

Reference

BREW API ISHELL_CancelAlarm | SFBShell::SetAlarm


SFBShell::CancelTimer
Cancel a timer that has been set by SFBShell::SetTimer().
[ public ]
SFCError CancelTimer(
    PFNNOTIFY notify = null   // user callback
    VoidPtr data = null       // user data
);

Example

Cancle a timer

SFBShellSmp     shell = SFBShell::GetInstance();

// cancle a timer.
shell->CancelTimer(OnTimerEntry, this);

Reference

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


SFBShell::CheckPrivLevel
Check the privilege level of the currently running application against the specified value.
[ public ]
Bool CheckPrivLevel(
    AEECLSID privilege      // privilege bit
    Bool queryOnly = true   // if true, this is a query only. 
                            // if false, the application terminates if it does not have the privileges 
);

Example

Check whether can access a file.

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

// check the privilege level of applet
// check whether can access the file
ok = shell->CheckPrivLevel(PL_FILE, true);

Reference

BREW API ISHELL_CheckPrivLevel | BREW API AEE Privilege Levels


SFBShell::ClearProperty
CLear the property data of the basic module that related to input class.
[ public ]
SFCError ClearProperty(
    AEECLSID clsid   // class of the application to query
    UInt16 wId       // property ID
);

Return value

  • If succeeds: SFERR_NO_ERROR
  • If insufficient memory: SFERR_NO_MEMORY
  • If input class not found : EBADCLASS
  • If caller does not have sufficient privileges : EPRIVLEVEL

Version

This function is available in BREW 3.1.

Description

Calling this function is as same as calling the SFBShell::SetProperty(clsid, wId, null, 0); .

Reference

SFBShell::SetProperty | SFBShell::GetProperty


SFBShell::ClearShutdownErrors
Clear the error status of all the applications.
[ public ]
SFCError ClearShutdow(Void);

Return value

  • If succeeds: SFERR_NO_ERROR
  • If failed: SFERR_NO_MEMORY
  • If caller does not have sufficient privileges : EPRIVLEVEL

Version

This function is onlu available in BREW 3.0.

Reference

SFBShell::StartApplet | SFBShell::StartAppletEx


SFBShell::CloseApplet
Instruct the AEE Shell to close the active applet.
[ public ]
SFCError CloseApplet(
    Bool returnToIdle = false   // if true, close the applet, return to title
);

Example

Close current applet.

SFBShellSmp     shell = SFBShell::GetInstance();

// close current applet.
shell->CloseApplet(false);

Reference

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


SFBShell::CreateDialog
Instruct the AEE Shell to start a dialog associate with the input DialogInfo data structure or the dialog information in the associated resource file.
[ public ]
SFCError CreateDialog(
    ACharConstPtr resFile   // resource file
    UInt16 id               // resource ID
);
[ public ]
SFCError CreateDialog(
    DialogInfo* info   // structure that substituted dialog information
);
[ public ]
SFCError CreateDialog(
    SFXAnsiStringConstRef resFile   // resource file
    UInt16 id                       // resource ID
);

Reference

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


SFBShell::CreateInstance
Create an object associated with the specified 32-bit ClassID.
[ public ]
SFCError CreateInstance(
    AEECLSID clsid         // ClassID
    SFBBaseSmpPtr handle   // pointer to Smart-Pointer
);
[ public ]
SFBBaseSmp CreateInstance(
    AEECLSID clsid   // ClassID
);

Reference

BREW API ISHELL_CreateInstance | SFBModule::CreateInstance


SFBShell::DetectType
Given data in a buffer or the name of an object, this function detects the MIME type.
[ public ]
SFCError DetectType(
    VoidConstPtr data       // data buffer
    UInt32Ptr size          // data size
    ACharConstPtr name      // name of the object
    ACharConstHandle mime   // handle of MIME string returned to caller
);
[ public ]
SFCError DetectType(
    SFXBufferConstRef data   // data buffer
    UInt32Ptr additional     // additional number of bytes for detecting the type when output(Buffer size is auto initialized)
    ACharConstPtr name       // name of the object
    ACharConstHandle mime    // handle of MIME string returned to caller
);
[ public ]
SFCError DetectType(
    VoidConstPtr data            // data buffer
    UInt32Ptr size               // data size
    SFXAnsiStringConstRef name   // name of the object
    SFXAnsiStringPtr mime        // handle of MIME string returned to caller
);
[ public ]
SFCError DetectType(
    SFXBufferConstRef data       // data buffer
    UInt32Ptr additional         // additional number of bytes for detecting the type when output(Buffer size is auto initialized)
    SFXAnsiStringConstRef name   // name of the object
    SFXAnsiStringPtr mime        // handle of MIME string returned to caller
);
[ public ]
SFCError DetectType(
    VoidConstPtr data       // data buffer
    UInt32Ptr size          // data size
    SFXAnsiStringPtr mime   // handle of MIME string returned to caller
);
[ public ]
SFCError DetectType(
    SFXBufferConstRef data   // data buffer
    UInt32Ptr additional     // additional number of bytes for detecting the type when output(Buffer size is auto initialized)
    SFXAnsiStringPtr mime    // handle of MIME string returned to caller
);

Reference

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


SFBShell::EndDialog
This function closes the currently active dialog.
[ public ]
SFCError EndDialog(Void);

Reference

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


SFBShell::EnumAppletInit
Reset the AEE Shell’s internal applet enumeration index.
[ public ]
Void EnumAppletInit(Void);

Reference

BREW API ISHELL_EnumAppletInit


SFBShell::EnumNextApplet
Return information about the next applet.
[ public ]
AEECLSID EnumNextApplet(
    AEEAppInfo* info   // pointer to the AEEAppInfo structure to fill
);

Example

Enumerate the applet, Get the information of the next applet.

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

// initialize the enumeration of applet.
shell->EnumAppletInit();

// get the information of the next applet.
shell->EnumNextApplet(&appInfo);

Reference

BREW API ISHELL_EnumNextApplet | AEEAppInfo | SFBShell::EnumAppletInit


SFBShell::ForceExit
Return true if the applet must exit.
[ public ]
Bool ForceExit(Void);

Reference

BREW API ISHELL_ForceExit | SFBShell::Busy


SFBShell::FreeResData
Free the data previously returned by SFBShell::LoadResData().
[ public ]
Void FreeResData(
    VoidPtr data   // resource Data that is to be freed 
);

Reference

BREW API ISHELL_FreeResData | SFBShell::LoadResData


SFBShell::GetActiveDialog
Return the current active dialog.
[ public ]
SFBDialogSmp GetActiveDialog(Void);

Reference

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


SFBShell::GetAppAuthor
Get the name of the author of the active applet.
[ public ]
SInt32 GetAppAuthor(
    WCharPtr buf   // buffer to fill with the author name string 
    SInt32 size    // size in bytes of the input buffer 
);
[ public ]
SInt32 GetAppAuthor(
    SFXWideStringPtr string   // buffer to fill with the author name string 
);

Example

Retrieve the name of the author of the active applet.

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

// allocate the buffer to receive data
author.SetLength(20);

// retrieve the name of the author of the active applet. 
shell->GetAppAuthor(&author);
// or
shell->GetAppAuthor(author.GetBuffer(), sizeof(WChar) * author.GetLength());

Reference

BREW API ISHELL_GetAppAuthor


SFBShell::GetAppCopyright
Get the copyright string of the active applet.
[ public ]
SInt32 GetAppCopyright(
    WCharPtr buf   // buffer to fill with the string 
    SInt32 size    // size in bytes of the input buffer 
);
[ public ]
SInt32 GetAppCopyright(
    SFXWideStringPtr string   // buffer to fill with the string 
);

Example

Retrieve the copyright string of the active applet.

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

// sllocate the buffer to receive data
copyright.SetLength(30);

// retrieve the copyright string of the active applet.
shell->GetAppCopyright(&copyright);
// or
shell->GetAppCopyright(copyright.GetBuffer(), sizeof(WChar) * copyright.GetLength());

Reference

BREW API ISHELL_GetAppCopyright


SFBShell::GetAppPrefs
Get the structure containing applet preferences.
[ public ]
SInt32 GetAppPrefs(
    UInt16 version   // version of the preference 
    VoidPtr buf      // pointer to memory to fill with preference data 
    UInt16 size      // size of memory block to fill 
);
[ public ]
SInt32 GetAppPrefs(
    UInt16 version     // version of the preference 
    SFXBufferPtr buf   // if null, it returns null Buffer pointer and 0 Buffer size to the API
);

Reference

BREW API ISHELL_GetAppPrefs | SFBShell::SetAppPrefs


SFBShell::GetAppVersion
Get the version string of the active applet.
[ public ]
SInt32 GetAppVersion(
    WCharPtr buf   // buffer to fill with the string 
    SInt32 size    // size in bytes of the input buffer 
);
[ public ]
SInt32 GetAppVersion(
    SFXWideStringPtr string   // buffer to fill with the string 
);

Example

Retrieve the version string of the active applet.

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

// allocate the buffer to receive data
version.SetLength(20);

// retrieve the version string of the active applet. 
shell->GetAppVersion(&version);
// or
shell->GetAppVersion(version..GetBuffer(), sizeof(WChar) * version.GetLength());

Reference

BREW API ISHELL_GetAppVersion


SFBShell::GetClassItemID
Get a 32-bit unique identifier associated with the owning module for the specified class ID.
[ public ]
UInt32 GetClassItemID(
    AEECLSID clsid   // ClassID
);

Version

Supported in BREW 2.1 or later.

Reference

BREW API ISHELL_GetClassItemID


SFBShell::GetDeviceInfo
Get the AEE Shell for information about the capabilities of the device, such as the amount of supported RAM, the screen display, and other items.
[ public ]
Void GetDeviceInfo(
    AEEDeviceInfo* info   // pointer to the AEEDeviceInfo structure to fill
);

Description

Get the device information. In SophiaFramework, we can use SFXDevice to get the device information.

Example

Get the device information.

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

// get the device information
shell->GetDeviceInfo(&deviceInfo);

Reference

BREW API ISHELL_GetDeviceInfo | BREW API AEEDeviceInfo | SFXDevice


SFBShell::GetDeviceInfoEx
Get specific information about the device. This function takes an ID that specifies what information is needed. The buffer contains the corresponding information on return.
[ public ]
SFCError GetDeviceInfoEx(
    AEEDeviceItem item   // specifies the Item whose info is needed
    VoidPtr info         // contains the corresponding information on return
    SInt32Ptr size       // buffer size
);
[ public ]
SFCError GetDeviceInfoEx(
    AEEDeviceItem item   // specifies the Item whose info is needed
    SFXBufferPtr info    // contains the corresponding information on return, size can be modified automatically
);

Example

Get the ChipID.

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

// get the ChipID.
shell->GetDeviceInfoEx(AEE_DEVICEITEM_CHIP_ID, data, &size);

Reference

BREW API ISHELL_GetDeviceInfoEx | AEEDeviceItem | SFXDevice


SFBShell::GetHandler
Provide query access to the AEE Shell’s database of registered content viewers and protocol scheme handlers.
[ public ]
AEECLSID GetHandler(
    AEECLSID type      // handler type or an AEECLSID base class
    ACharConstPtr in   // input srting
);
[ public ]
AEECLSID GetHandler(
    AEECLSID type              // handler type or an AEECLSID base class
    SFXAnsiStringConstRef in   // input string
);

Reference

BREW API ISHELL_GetHandler | AEEHandlerType | SFBShell::RegisterHandler


SFBShell::GetInstance
Get the SFBShell instance.
[ public, static ]
SFBShellSmp GetInstance(Void);

Example

Get the SFBShell instance.

SFBShellSmp     shell = SFBShell::GetInstance();

SFBShell::GetItemStyle
Get the AEE Shell for information about the default style for menu, icon, or list items.
[ public ]
Void GetItemStyle(
    AEEItemType type         // item type
    AEEItemStyle* normal     // pointer to the AEEItemStyle to fill for items that are not selected
    AEEItemStyle* selected   // pointer to the AEEItemStyle to fill for selected items
);

Reference

BREW API ISHELL_GetItemStyle | AEEItemType | AEEItemStyle


SFBShell::GetJulianDate
Get a JulianType data structure based on the input second value.
[ public ]
Void GetJulianDate(
    UInt32 seconds     // seconds since January 6 1980, the device reference time
    JulianType* date   // pointer to the structure that needs to be filled on return
);

Reference

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


SFBShell::GetPrefs
Get the structure containing applet or class level preferences.
[ public ]
SInt32 GetPrefs(
    AEECLSID clsid   // ClassID
    UInt16 version   // version of the preference
    VoidPtr config   // pointer to the memory to fill with preference data
    UInt16 size      // size of memory block to fill
);
[ public ]
SInt32 GetPrefs(
    AEECLSID clsid        // ClassID
    UInt16 version        // version of the preference
    SFXBufferPtr config   // if null, it returns null Buffer pointer and 0 Buffer size to the API
);

Reference

BREW API ISHELL_GetPrefs | SFBShell::SetPrefs


SFBShell::GetProperty
Retrieve the property data for the underlying module associated with the input class.
[ public ]
SFCError GetProperty(
    AEECLSID clsid   // class of the application to query
    UInt16 wId       // property ID
    VoidPtr dest     // destination to fill
    UInt16Ptr size   // pointer to size of input buffer
);
[ public ]
SFCError GetProperty(
    AEECLSID clsid      // class of the application to query
    UInt16 wId          // property ID
    SFXBufferPtr dest   // if null, return SFERR_INVALID_PARAM
);

Return value

  • If succeeds: SFERR_NO_ERROR
  • If invalid argument: SFERR_INVALID_PARAM
  • If insufficient memory: SFERR_NO_MEMORY
  • If input class not found : EBADCLASS
  • If caller does not have sufficient privileges : EPRIVLEVEL

Version

This function is available in BREW 3.1.

Reference

BREW API ISHELL_GetProperty | SFBShell::SetProperty


SFBShell::GetResSize
Get the size of the found resource, or 0 if the resource is not found. A wrapper for SFBShell::LoadResDataEx().
[ public ]
UInt32 GetResSize(
    ACharConstPtr file   // resource file containing the data
    UInt16 id            // id of the data in the resource file 
    ResType type         // the type of resource
    UInt32Ptr size       // buffer size
);
[ public ]
UInt32 GetResSize(
    SFXAnsiStringConstRef file   
    UInt16 id                    
    ResType type                 
    UInt32Ptr size               
);

Reference

BREW API ISHELL_GetResSize | SFBShell::LoadResDataEx


SFBShell::GetTimeMS
Get the current time of day in milliseconds.
[ public ]
UInt32 GetTimeMS(Void);

Reference

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


SFBShell::GetTimerExpiration
Get the remaining time in milliseconds before the timer associated with the device user callback/data expires.
[ public ]
UInt32 GetTimerExpiration(
    PFNNOTIFY notify      // user callback
    VoidPtr data = null   // user data
);

Example

Get left time till timer expired.

// callback function for the timer.
static Void OnTimerEntry(VoidPtr arg);

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

// get left time till timer expired.
duration = shell->GetTimerExpiration(OnTimerEntry, this);

Reference

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


SFBShell::GetUpTimeMS
Get the millisecond elapsed since the time the device was powered on.
[ public ]
UInt32 GetUpTimeMS(Void);

Reference

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


SFBShell::HandleEvent
Send one of the specified standard AEEEvent items to the currently active applet.
[ public ]
Bool HandleEvent(
    AEEEvent event   // AEEEvent items
    UInt16 wParam    // event-specific 16-bit value
    UInt32 dwParam   // event-specific 32-bit value
);
[ public ]
Bool HandleEvent(
    SFXEventConstRef event   
);

Reference

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


SFBShell::IsValidResource
Check to see if the specified resource file entry is valid for the type specified.
[ public ]
Bool IsValidResource(
    ACharConstPtr file           // resource file name
    UInt16 id                    // id of the resource
    ResType resType              // resource type
    AEEHandlerType handlerType   // handler type
);
[ public ]
Bool IsValidResource(
    SFXAnsiStringConstRef file   // resource file name
    UInt16 id                    // id of the resource
    ResType resType              // resource type
    AEEHandlerType handlerType   // handler type
);

Reference

BREW API ISHELL_IsValidResource | ResType | AEEHandlerType


SFBShell::LoadBitmap
Load an bitmap file directly and returns the SFBBitmap interface for the bitmap.
[ public ]
SFBBitmapSmp LoadBitmap(
    ACharConstPtr file   // image file name
);
[ public ]
SFBBitmapSmp LoadBitmap(
    SFXAnsiStringConstRef file   // image file name
);

Reference

BREW API ISHELL_LoadBitmap | SFBShell::LoadResBitmap


SFBShell::LoadBusyImage
This method loads the image used for indicating that BREW is busy.
[ public ]
SFBImageSmp LoadBusyImage(Void);

Reference

BREW API ISHELL_LoadBusyImage


SFBShell::LoadImage
Load an image directly from a file and returns a pointer to an SFBImage interface that can be used to display the image.
[ public ]
SFBImageSmp LoadImage(
    ACharConstPtr file   // image file name
);
[ public ]
SFBImageSmp LoadImage(
    SFXAnsiStringConstRef file   // image file name
);

Reference

BREW API ISHELL_LoadImage | SFBShell::LoadResData | SFBShell::LoadResImage | SFBShell::LoadResObject | SFBShell::LoadResSound | SFBShell::LoadResString | SFBShell::LoadSound | SFBShell::FreeResData


SFBShell::LoadResBitmap
Load a bitmap resource from the given resource file and returns a valid SFBBitmap interface pointer.
[ public ]
SFBBitmapSmp LoadResBitmap(
    ACharConstPtr resFile   // resource file
    UInt16 id               // resource ID
);
[ public ]
SFBBitmapSmp LoadResBitmap(
    SFXAnsiStringConstRef resFile   // resource file
    UInt16 id                       // resource ID
);

Example

Get bitmap from the resource file, draw it on the device screen.

// resourse ID of bitmap which read from resourse file.
#define IDB_MY_PICTURE  0x0001

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

// get bitmap from the resource file.
bmp = shell->LoadResBitmap(MYRESOURCE_RES_FILE, IDB_MY_PICTURE);

if (bmp != null) {
    // draw the bitmap.
    display->BitBlt(SFXRectangle(0, 0, 100, 100), bmp, SFXGrid(0, 0));

    // refresh the screen.
    display->Update();
}

Reference

BREW API ISHELL_LoadResBitmap | SFBShell::LoadBitmap


SFBShell::LoadResData
Return a void * data block associated with the specified resource file, ID, and type.
[ public ]
VoidPtr LoadResData(
    ACharConstPtr resFile   // resource file containing the data
    UInt16 id               // id of the data in the resource file
    ResType type            // the type of resource
);
[ public ]
VoidPtr LoadResData(
    SFXAnsiStringConstRef resFile   // resource file containing the data
    UInt16 id                       // id of the data in the resource file
    ResType type                    // the type of resource
);

Reference

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


SFBShell::LoadResDataEx
Attempt to load the resource specified by type and ID from the specified resource context. The function either allocates memory or loads into a pre-allocated buffer.
[ public ]
VoidPtr LoadResDataEx(
    ACharConstPtr resFile   // resource file containing the data
    UInt16 id               // id of the data in the resource file
    ResType type            // the type of resource
    VoidPtr buf             // buffer into which to load the resource data
    UInt32Ptr size          // buffer size
);
[ public ]
VoidPtr LoadResDataEx(
    SFXAnsiStringConstRef resFile   // resource file containing the data
    UInt16 id                       // id of the data in the resource file
    ResType type                    // the type of resource
    VoidPtr buf                     // buffer into which to load the resource data
    UInt32Ptr size                  // buffer size
);
[ public ]
VoidPtr LoadResDataEx(
    SFXAnsiStringConstRef resFile   // resource file containing the data
    UInt16 id                       // id of the data in the resource file
    ResType type                    // the type of resource
    SFXBufferPtr buf                // buffer into which to load the resource data
);

Reference

BREW API ISHELL_LoadResDataEx | SFBShell::FreeResData | AEEResBlob


SFBShell::LoadResImage
Load a bitmap resource from the given resource file and returns a valid SFBImage Interface pointer. This pointer can then be used for viewing the image.
[ public ]
SFBImageSmp LoadResImage(
    ACharConstPtr resFile   // resource file containing the bitmap image
    UInt16 id               // id of the bitmap in the resource file
);
[ public ]
SFBImageSmp LoadResImage(
    SFXAnsiStringConstRef resFile   // resource file containing the bitmap image
    UInt16 id                       // id of the bitmap in the resource file
);

Example

Get bitmap image from the resource file, draw it on device screen.

// resourceID of bitmap which read from the resource file.
#define IDB_MY_PICTURE  0x0001

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

// retrieve image(bitmap image) from the resource file.
image = shell->LoadResImage(MYRESOURCE_RES_FILE, IDB_MY_PICTURE);

if (image != null) {
    // get the imformation of the image.
    image->GetInfo(&imageInfo);

    // check whether the SFBImage object contains a image.
    if (imageInfo.cx == 0) {
        DBGPRINTF("Failed to load image…!");
        image.Release();
    }
    else {
        // draw the inage on screen.
        image->Draw(0, 0);
    }
}

Reference

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


SFBShell::LoadResObject
Load the specified resource and creates a handler that can be used on the resource data.
[ public ]
SFBBaseSmp LoadResObject(
    ACharConstPtr resFile   // resource file containing the specified resource
    UInt16 id               // id of the resource in the resource file
    AEECLSID clsidBase      // resource type
);
[ public ]
SFBBaseSmp LoadResObject(
    SFXAnsiStringConstRef resFile   // resource file containing the specified resource
    UInt16 id                       // id of the resource in the resource file
    AEECLSID clsidBase              // resource type
);

Reference

BREW API ISHELL_LoadResObject | SFBShell::LoadImage | SFBShell::LoadResData | SFBShell::LoadResImage | SFBShell::LoadResSound | SFBShell::LoadResString | SFBShell::LoadSound | SFBShell::FreeResData


SFBShell::LoadResSound
Load a sound file from the file system and returns the SFBSoundPlayer Interface object for the file when the sound data is included in a resource file as a raw stream of bytes.
[ public ]
SFBSoundPlayerSmp LoadResSound(
    ACharConstPtr resFile   // resource file containing the raw sound data
    UInt16 id               // id of the raw sound data
);
[ public ]
SFBSoundPlayerSmp LoadResSound(
    SFXAnsiStringConstRef resFile   // resource file containing the raw sound data
    UInt16 id                       // id of the raw sound data
);

Reference

BREW API ISHELL_LoadResSound | SFBShell::LoadImage | SFBShell::LoadResData | SFBShell::LoadResImage | SFBShell::LoadResObject | SFBShell::LoadResString | SFBShell::LoadSound


SFBShell::LoadResString
Load UNICODE or ISOLATIN strings stored in the specified resource file.
[ public ]
SInt32 LoadResString(
    ACharConstPtr resFile   // resource file containing the string
    UInt16 id               // id of the string in the resource file
    WCharPtr buf            // buffer to fill with the string
    SInt32 size             // size in bytes of the input buffer
);
[ public ]
SFXWideString LoadResString(
    SFXAnsiStringConstRef resFile   // resource file containing the string
    UInt16 id                       // id of the string in the resource file
);
[ public ]
SInt32 LoadResString(
    ACharConstPtr resFile     // resource file containing the string
    UInt16 id                 // id of the string in the resource file
    SFXWideStringPtr string   // buffer to fill with the string
);
[ public ]
SInt32 LoadResString(
    SFXAnsiStringConstRef resFile   // resource file containing the string
    UInt16 id                       // id of the string in the resource file
    SFXWideStringPtr string         // size in bytes of the input buffer
);

Example

Get string from the resource file, Draw it on device screen.

// resourceID of the string which read from the resource file.
#define IDS_MY_LETTERS  0x0011

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

// get the string from the resource file.
string = shell->LoadResString(MYRESOURCE_RES_FILE, IDS_MY_LETTERS);

// draw the string on the screen.
display->DrawText(AEE_FONT_BOLD, string, -1, 0, 0, null, IDF_ALIGN_CENTER | IDF_ALIGN_MIDDLE);

// refresh the screen.
display->Update();

Reference

BREW API ISHELL_LoadResString | SFBShell::LoadImage | SFBShell::LoadResData | SFBShell::LoadResImage | SFBShell::LoadResObject | SFBShell::LoadResSound | SFBShell::LoadSound


SFBShell::LoadSound
Load a sound file from the file system and returns the SFBSoundPlayer Interface object for the file.
[ public ]
SFBSoundPlayerSmp LoadSound(
    ACharConstPtr resFile   // sound file
);
[ public ]
SFBSoundPlayerSmp LoadSound(
    SFXAnsiStringConstRef resFile   // sound file
);

Reference

BREW API ISHELL_LoadSound | SFBShell::LoadImage | SFBShell::LoadResData | SFBShell::LoadResImage | SFBShell::LoadResObject | SFBShell::LoadResSound | SFBShell::LoadResString | SFBShell::FreeResData


SFBShell::MessageBox
Instruct the AEE Shell to display a message box to the device user. A message box is a simple window with a title and text.
[ public ]
Bool MessageBox(
    ACharConstPtr resFile   // resource file containing the title and text
    UInt16 titleId          // id of the title
    UInt16 textId           // id of the text
);
[ public ]
Bool MessageBox(
    SFXAnsiStringConstRef resFile   // resource file containing the title and text
    UInt16 titleId                  // id of the title
    UInt16 textId                   // id of the text
);

Reference

BREW API ISHELL_MessageBox | SFBShell::MessageBoxText


SFBShell::MessageBoxText
Instruct the AEE Shell to display a message box to the device user. A message box is a simple window with a title and text.
[ public ]
Bool MessageBoxText(
    WCharConstPtr title   // the title string
    WCharConstPtr text    // the text
);
[ public ]
Bool MessageBoxText(
    SFXWideStringConstRef title   // the title string
    SFXWideStringConstRef text    // the text
);

Reference

BREW API ISHELL_MessageBoxText | SFBShell::MessageBox


SFBShell::Notify
This function is called by an object when it detects an event that may be associated with a notification requested by another class of object.
[ public ]
SFCError Notify(
    AEECLSID clsid   // ClassID that issued the notification
    UInt32 mask      // mask of event
    VoidPtr data     // context sensitive data
);

Reference

BREW API ISHELL_Notify | SFBShell::RegisterNotify


SFBShell::OnAppClose
Enable an applet to register a system callback that gets called when applet closes.
[ public ]
Void OnAppClose(
    SFXCallbackPtr callback   // the callback
);

Reference

BREW API ISHELL_OnAppClose | SFXCallback


SFBShell::OnAppExit
Enable an applet to register a callback that gets called after applet destructor is executed.
[ public ]
Void OnAppExit(
    SFXCallbackPtr callback   // pointer to the callback
);

Reference

BREW API IShell_OnAppExit


SFBShell::OnExit
Enable an applet to register a system callback that gets called when BREW exits.
[ public ]
Void OnExit(
    SFXCallbackPtr callback   // the callback
);

Reference

BREW API ISHELL_OnExit | SFXCallback


SFBShell::OnInit
Enable an applet to register a system callback that gets called when BREW initializes.
[ public ]
Void OnInit(
    SFXCallbackPtr callback   // the callback
);

Reference

BREW API ISHELL_OnInit


SFBShell::OnLowRAM
Register for the callback to be invoked when the system reaches low memory condition.
[ public ]
Void OnLowRAM(
    SFXCallbackPtr callback   // callback to be invoked
);

Reference

BREW API ISHELL_OnLowRAM


SFBShell::OnLowRAMCritical
Register for the callback to be invoked when the system reaches low memory condition.
[ public ]
Void OnLowRAMCritical(
    SFXCallbackPtr callback   // callback to be invoked
);

Version

This function is available in BREW 3.1.

Reference

BREW API ISHELL_OnLowRAMCritical | SFBShell::OnLowRAM


SFBShell::OnLowStorage
Register for the callback to be invoked when the system reaches low file-system space condition.
[ public ]
Void OnLowStorage(
    SFXCallbackPtr callback   // callback to be invoked
);

Reference

BREW API ISHELL_OnLowStorage


SFBShell::OnModUnload
Register a callback to be called when the module is about to be unloaded.
[ public ]
Void OnModUnload(
    SFXCallbackPtr callback   // pointer to the Callback class structure 
);

Reference

BREW API ISHELL_OnModUnload | SFBShell::RegisterSystemCallback


SFBShell::PostEvent
Post an asynchronous event to the specified applet.
[ public ]
Bool PostEvent(
    AEECLSID clsid   // ClassID of the applet for the event
    AEEEvent event   // AEEEvent items
    UInt16 wValue    // event-specific 16-bit value
    UInt32 dwValue   // event-specific 32-bit value
);
[ public ]
Bool PostEvent(
    AEECLSID clsid           // ClassID of the applet for the event
    SFXEventConstRef event   // event
);

Return values

true: if the event was posted. false: if the event was not posted.

Description

The function is similar to ISHELL_SendEvent(). The main difference is that this function posts the event to the applet, and ISHELL_SendEvent() immediately sends the event to the applet. Event posting is provided for special cases where the caller either posts an event from another task or defers the processing of the event until the next iteration of the event loop.

Example

Post a force-redraw event to the applet.

SFBShellSmp     shell = SFBShell::GetInstance();

// post a force-redraw event to the applet.
shell->PostEvent(SFCApplet::GetClassID(), SFXEvent(SREVT_RESPONDER_RENDER, SRP16_RENDER_INVOKE, true));

Reference

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


SFBShell::PostEventEx
Post an asynchronous event to the specified app.
[ public ]
Bool PostEventEx(
    UInt16 flags     // flags to specify how the event must be posted. 
                     // if no flags are used, this parameter is set to 0. The typical usage is to set this value to 0. 
                     // if it is set to EVTFLG_UNIQUE, Processing is as same as SFBShell::PostEvent()
    AEECLSID clsid   // ClassID of the applet for the event
    AEEEvent event   // AEE Event
    UInt16 wValue    // event-specific 16-bit value
    UInt32 dwValue   // event-specific 32-bit value
);
[ public ]
Bool PostEventEx(
    UInt16 flags             // flags to specify how the event must be posted. 
                             // if no flags are used, this parameter is set to 0. The typical usage is to set this value to 0. 
                             // if it is set to EVTFLG_UNIQUE, Processing is as same as SFBShell::PostEvent()
    AEECLSID clsid           // ClassID of the applet for the event
    SFXEventConstRef event   // event
);

Return value

true: if the event was posted. false: if the event was not posted

Description

This function is very similar to ISHELL_PostEvent(). The main difference is that this function allows multiple events of the same type (same event code) to be posted and pending to be dispatched for the same app.

Version

Supported in BREW 2.1 or later.

Example

Post a force-redraw event to the applet.

SFBShellSmp     shell = SFBShell::GetInstance();

// post a force-redraw event to the applet.
shell->PostEvent(0, SFCApplet::GetClassID(), SFXEvent(SREVT_RESPONDER_RENDER, SRP16_RENDER_INVOKE, true));

Reference

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


SFBShell::PostURL
Post an asynchronous event, EVT_APP_POST_URL, to the applet associated with the URL's scheme.
[ public ]
Bool PostURL(
    ACharConstPtr url   // pointer to the URL
);

Return value

  • The event was posted: true
  • The event was not posted: false

Version

This function is available in BREW 3.1.

Reference

BREW API ISHELL_PostURL | SFBShell::PostEvent


SFBShell::Prompt
Provide a mechanism for an application to display a multi selection prompt.
[ public ]
Bool Prompt(
    AEEPromptInfo* info   // pointer to the AEEPromptInfo data structure
);

Reference

BREW API ISHELL_Prompt | AEEPromptInfo


SFBShell::QueryClass
Query the AEE Shell to determine if the specified class or applet is supported.
[ public ]
Bool QueryClass(
    AEECLSID clsid     // ClassID
    AEEAppInfo* info   // pointer to the AEEAppInfo structure
);

Reference

BREW API ISHELL_QueryClass | AEEAppInfo | SFBShell::CreateInstance


SFBShell::RegisterEvent
Register a custom AEEEvent based upon the input string.
[ public ]
AEEEvent RegisterEvent(
    ACharConstPtr name   // pointer to name of the event
    SInt32Ptr count      // count of attempts to register this event
);
[ public ]
AEEEvent RegisterEvent(
    SFXAnsiStringConstRef name   // pointer to name of the event
    SInt32Ptr count              // count of attempts to register this event
);

Version

This function is available in BREW 3.1.

Reference

BREW API ISHELL_RegisterEvent


SFBShell::RegisterHandler
Provide a mechanism for a content viewer or protocol engine to register itself with the AEE Shell.
[ public ]
SFCError RegisterHandler(
    AEECLSID clsidBase   // handler type (HTYPE_VIEWER, HTYPE_SOUND) base class
    ACharConstPtr in     // input string
    AEECLSID clsid       // AEECLSID of the handler
);
[ public ]
SFCError RegisterHandler(
    AEECLSID clsidBase         // handler type (HTYPE_VIEWER, HTYPE_SOUND) base class
    SFXAnsiStringConstRef in   // input string
    AEECLSID clsid             // AEECLSID of the handler
);

Reference

BREW API ISHELL_RegisterHandler | AEEHandlerType | SFBShell::GetHandler


SFBShell::RegisterNotify
Register for notifications that are issued from other classes.
[ public ]
SFCError RegisterNotify(
    AEECLSID clsidNotify   // applet to create and notify when the event occurs
    AEECLSID clsidType     // class that issues the event
    UInt32 mask            // mask of events to trigger
);

Reference

BREW API ISHELL_RegisterNotify | SFBShell::Notify


SFBShell::RegisterSystemCallback
Register callbacks for important system events like: when BREW starts-up, when application exits, when mod is unloaded, etc.
[ public ]
Void RegisterSystemCallback(
    SFXCallbackPtr callback   // the callback
    SInt32 type               // registered system callback type
);

Reference

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


SFBShell::Reset
Reset the device.
[ public ]
SFCError Reset(
    AEEResetType type   // AEEResetType. This indicates the type of reset
);

Return value

  • If succeeds: SFERR_NO_ERROR
  • If invalid argument: SFERR_INVALID_PARAM
  • If no privilege : EPRIVLEVEL

Version

This function is available in BREW 3.1.

Reference

BREW API ISHELL_Reset |


SFBShell::Resume
Register a callback with the AEE Shell.
[ public ]
Void Resume(
    SFXCallbackPtr callback   // the callback
);

Reference

BREW API ISHELL_Resume | SFXCallback


SFBShell::ResumeAlarms
Resume operation the BREW alarms subsystem.
[ public ]
SFCError ResumeAlarms(Void);

Return value

  • If succeeds: SFERR_NO_ERROR
  • If no privilege : EPRIVLEVEL
  • If failed: Error code defined in AEEError.h

Version

This function is available in BREW 3.1.

Reference

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


SFBShell::SendEvent
Send the event directly to the destination applet.
[ public ]
Bool SendEvent(
    AEECLSID clsid   // ClassID of the applet for the event
    AEEEvent event   // AEEEvent items
    UInt16 wParam    // event-specific 16-bit value
    UInt32 dwParam   // event-specific 32-bit value
);
[ public ]
Bool SendEvent(
    AEECLSID clsid           // ClassID of the applet for the event
    SFXEventConstRef event   // event
);

Return value

true: if the event was processed. false: if the event was not processed.

Example

Post a force-redraw event to the applet.

SFBShellSmp         shell = SFBShell::GetInstance();

// post a force-redraw event to the applet.
shell->SendEvent(SFCApplet::GetClassID(), SFXEvent(SREVT_RESPONDER_RENDER, SRP16_RENDER_INVOKE, true));

Reference

BREW API ISHELL_SendEvent | SFBShell::PostEvent | SFBShell::PostEventEx


SFBShell::SendURL
Post a synchronous event, EVT_APP_POST_URL, to the applet associated with the URL's scheme.
[ public ]
Bool SendURL(
    ACharConstPtr url   // pointer to the URL
);
[ public ]
Bool SendURL(
    SFXAnsiStringConstRef url   // pointer to the URL
);

Return value

  • If the event was processed: true
  • If the event was not processed: false

Version

This function is available in BREW 3.1.

Reference

BREW API ISHELL_PostURL | SFBShell::PostEvent


SFBShell::SetAlarm
Set a long-term alarm for an applet.
[ public ]
SFCError SetAlarm(
    AEECLSID clsid   // ClassID
    UInt16 code      // 16-bit code passed to the applet
    UInt32 minutes   // number of minutes to set the alarm from the current time
);

Reference

BREW API ISHELL_SetAlarm | SFBShell::CancelAlarm


SFBShell::SetAppPrefs
Set the structure containing applet specific preferences.
[ public ]
SFCError SetAppPrefs(
    UInt16 version   // version of the preference
    VoidPtr config   // pointer to the preference data to be stored
    UInt16 size      // size of memory block to store
);
[ public ]
SFCError SetAppPrefs(
    UInt16 version        // version of the preference
    SFXBufferPtr config   // pointer to the preference data to be stored
);

Reference

BREW API ISHELL_SetAppPrefs | SFBShell::GetAppPrefs


SFBShell::SetPrefs
Provide a method for storing a structure containing applet or class level preferences.
[ public ]
SFCError SetPrefs(
    AEECLSID clsid   // ClassID
    UInt16 version   // version of the preference
    VoidPtr config   // pointer to the preference data to be stored
    UInt16 size      // size of memory block to store
);
[ public ]
SFCError SetPrefs(
    AEECLSID clsid        // ClassID
    UInt16 version        // version of the preference
    SFXBufferPtr config   // pointer to the preference data to be stored
);

Reference

BREW API ISHELL_SetPrefs | SFBShell::GetPrefs


SFBShell::SetProperty
Set the property data for the underlying module associated with the input class.
[ public ]
SFCError SetProperty(
    AEECLSID clsid   // class of the application to query 
    UInt16 wId       // property ID
    VoidPtr src      // destination to fill
    UInt16 size      // size of the buffer
);
[ public ]
SFCError SetProperty(
    AEECLSID clsid     // class of the application to query 
    UInt16 wId         // property ID
    SFXBufferPtr src   // pointer to the buffer
);

Return value

  • If succeeds: SFERR_NO_ERROR
  • If insufficient memory: SFERR_NO_MEMORY
  • If input class not found : EBADCLASS
  • If caller does not have sufficient privileges : EPRIVLEVEL

Version

This function is available in BREW 3.1.

Reference

BREW API ISHELL_SetProperty | SFBShell::GetProperty


SFBShell::SetTimer
Set a short-term timer.
[ public ]
SFCError SetTimer(
    SInt32 mSecs          // timer expiration in milliseconds
    PFNNOTIFY notify      // the user callback that is called when the timer expires
    VoidPtr data = null   // the user data pointer that is passed as the only parameter to the callback
);

Example

Move a rectangle to the right with a timer.

#define TIMER_VAL   100

// class definition of Shape class.
SFMTYPEDEFCLASS(Shape)
class Shape :public SFRApplication
{
private:
    SFXRectangle    _rect;

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

        // register the drawing handler.
        RegisterHandler(SREVT_RESPONDER_RENDER, SRP16_RENDER_CONTENT, HANDLER_BEFORE, OnDrawEntry, this);

        // set the timer.
        shell->SetTimer(TIMER_VAL, OnTimerEntry, this);

        // initialize the rectangle.
        _rect.Set(0, 0, 32, 32);
    }

    // drawing handler.
    Void OnDraw(SFXGraphicsPtr);
    static Bool OnDrawEntry(SFXEventConstRef event, VoidPtr data)
    {
 ShapePtr(data)->OnDraw(SFXGraphicsPtr(event.P32()));
        return true;
    }

    // timer handler.
    Void OnTimer(Void);
    static Void OnTimerEntry(VoidPtr data)
    {
 ShapePtr(data)->OnTimer();
    }
};

//
// the function to be called by the timer
// void Shape::OnTimer(Void)
{
    SFBShellSmp     shell = SFBShell::GetInstance();

    // move the rectangle 3 pixels to the right.
    _rect.Offset(3, 0);

    // post the re-draw event to the applet.
    shell->PostEvent(SFCApplet::GetClassID(), SFXEvent(SREVT_RESPONDER_RENDER, SRP16_RENDER_INVOKE, true));

    // set the timer again.
    shell->SetTimer(TIMER_VAL, OnTimerEntry, this);
}

//
// draring handler.
// void Shape::OnDraw(SFXGraphicsPtr g)
{

    SFBShellSmp   shell = SFBShell::GetInstance();

    // fill the background with white.
    g->SetBackground(SFXRGBColor(255, 255, 255));
    g->ClearRect(GetContentWorld());

    // draw a red rectangle.
    g->SetFillMode(true);
    g->SetFillColor(SFXRGBColor(255, 0, 0));
    g->DrawRect(_rect);
}

Reference

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


SFBShell::SetTimerEx
Set a short-term timer.
[ public ]
SFCError SetTimerEx(
    SInt32 mSecs              // timer expiration in milliseconds
    SFXCallbackPtr callback   // pointer to AEECallback structure
);

Example

Move a rectangle to the right with a timer.

#define TIMER_VAL   100

// class definition of Shape class.
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();

        // register the drawing handler.
        RegisterHandler(SREVT_RESPONDER_RENDER, SRP16_RENDER_CONTENT, HANDLER_BEFORE, OnDrawEntry, this);

        // set the timer.
        shell->SetTimerEx(TIMER_VAL, &_callback);

        // initialize the rectangle.
        _rect.Set(0, 0, 32, 32);
    }

    // drawing handler.
    Void OnDraw(SFXGraphicsPtr);
    static Bool OnDrawEntry(SFXEventConstRef event, VoidPtr data)
    {
 ShapePtr(data)->OnDraw(SFXGraphicsPtr(event.P32()));
        return true;
    }

    // timer handler.
    Void OnTimer(Void);
    static Void OnTimerEntry(VoidPtr data)
    {
 ShapePtr(data)->OnTimer();
    }
};

//
// the function to be called by the timer
// void Shape::OnTimer(Void)
{
    SFBShellSmp  shell = SFBShell::GetInstance();

    // move the rectangle 3 pixels to the right.
    _rect.Offset(3, 0);

    // post the re-draw event to the applet.
    shell->PostEvent(SFCApplet::GetClassID(), SFXEvent(SREVT_RESPONDER_RENDER, SRP16_RENDER_INVOKE, true));

    // set the timer again.
    shell->SetTimerEx(TIMER_VAL, &_callback);
}

//
// draring handler.
// void Shape::OnDraw(SFXGraphicsPtr g)
{

    SFBShellSmp   shell = SFBShell::GetInstance();

    // fill the background with white.
    g->SetBackground(SFXRGBColor(255, 255, 255));
    g->ClearRect(GetContentWorld());

    // draw a red rectangle.
    g->SetFillMode(true);
    g->SetFillColor(SFXRGBColor(255, 0, 0));
    g->DrawRect(_rect);
}

Reference

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


SFBShell::ShowCopyright
Display the copyright information about the applet.
[ public ]
Bool ShowCopyright(Void);

Reference

BREW API ISHELL_ShowCopyright


SFBShell::StartApplet
Instruct the AEE Shell to start the applet associated with the specified 32-bit ClassID.
[ public ]
SFCError StartApplet(
    AEECLSID clsid   // ClassID
);

Example

Start the applet associated with the specified ClassID.

SFBShellSmp shell = SFBShell::GetInstance();

// start the applet.
shell->StartApplet(AEECLSID_SAMPLEAPPLET);

Reference

BREW API ISHELL_StartApplet | SFBShell::CreateInstance | SFBShell::CanStartApplet | SFBShell::CloseApplet | SFBShell::ActiveApplet


SFBShell::StartAppletArgs
Instruct the AEE to start the applet associated with the specified 32-bit class ID, passing it the arguments.
[ public ]
SFCError StartAppletArgs(
    AEECLSID clsid       // ClassID
    ACharConstPtr args   // string of arguments to the application
);
[ public ]
SFCError StartAppletArgs(
    AEECLSID clsid               // ClassID
    SFXAnsiStringConstRef args   // string of arguments to the application
);

Reference

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


SFBShell::StartAppletEx
Instruct the AEE to start the applet associated with the specified 32-bit class ID using the flags specified.
[ public ]
SFCError StartAppletEx(
    AEECLSID clsid   // ClassID
    UInt16 flags     // behavior flags
);

Example

Start the applet associated with the specified ClassID. The applet receive the EVT_APP_CONFIG instead of EVT_APP_START when start.

SFBShellSmp shell = SFBShell::GetInstance();

// start the applet.
// if the SSA_CONFIG flag is set,
// start the applet with the EVT_APP_CONFIG event.
shell->StartAppletEx(AEECLSID_SAMPLEAPPLET, SSA_CONFIG);

Reference

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


SFBShell::StartBackgroundApplet
Start the applet with specified ClassID. Send the command line argument.
[ public ]
SFCError StartBackgroundApplet(
    AEECLSID clsid       // ClassID
    ACharConstPtr args   // ASCIIZ string of arguments to the application
);
[ public ]
SFCError StartBackgroundApplet(
    AEECLSID clsid               // ClassID
    SFXAnsiStringConstRef args   // ASCIIZ string of arguments to the application
);

Return value

  • If applet created and started: SFERR_NO_ERROR
  • If insufficient memory: SFERR_NO_MEMORY
  • If the specified cass is not supported: SFERR_CLASS_UNSUPPORTED
  • If another applet is already starting: EALREADY
  • If the specified shell class is invalid: EBADCLASS
  • If applet has expired: EEXPIRED
  • If the applet has been disabled: EFILENOEXISTS
  • If OEM won't allow loading this applet: EUNABLETOLOAD
  • If this application is already in the app-history and hence cannot be started in the background: ENOTALLOWED

Version

This function is available in BREW 3.1.

Reference

BREW API ISHELL_StartBackgroundApplet | SFBShell::CreateInstance | SFBShell::StartAppletEx | SFBShell::BrowseFile | SFBShell::BrowseURL


SFBShell::UnregisterHandler
Unregister the hander.
[ public ]
SFCError UnregisterHandler(
    SFXAnsiStringConstRef in   // input string
);

Reference

BREW API ISHELL_RegisterHandler | SFBShell::RegisterHandler