SFBAppletCtl

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

#include <SFBAppletCtl.h.hpp>

class SFBAppletCtl : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBAppletCtl)

継承図

バージョン

BREW 2.0	BREW 2.1	BREW 3.0	BREW 3.1
×	×	×	○

参照

BREW API IAppletCtl

メンバ

パブリック関数
`SFCError`	BrowseFile( `ACharConstPtr` file , `UInt32` reason ) BrowseFile( `SFXAnsiStringConstRef` file , `UInt32` reason ) ( 拡張子で ) 指定されたファイルタイプに関連付けられたアプレットを起動します。
`SFCError`	BrowseURL( `ACharConstPtr` url , `UInt32` reason ) BrowseURL( `SFXAnsiStringConstRef` url , `UInt32` reason ) 指定された URL スキームに関連付けられたアプレットを起動します。
`SFCError`	CanStart( `AEECLSID` clsid , `VoidPtr` buf , `SInt32Ptr` size ) CanStart( `AEECLSID` clsid , `SFXBufferPtr` buf ) 起動情報を与えた指定のアプレットが起動できるか判断します。
`SFCError`	Control( `AEECLSID` clsid , `SInt32` operation , `VoidPtr` buf , `SInt32Ptr` size ) Control( `AEECLSID` clsid , `SInt32` operation , `SFXBufferPtr` buf ) アプレットをコントロールします。
`SFCError`	GetRunningInfo( `AEECLSID` clsid , `AEEAppItem` item , `VoidPtr` buf , `SInt32Ptr` size ) GetRunningInfo( `AEECLSID` clsid , `AEEAppItem` item , `SFXBufferPtr` buf ) 現在実行中のアプリケーションに関する特定の情報を取得します。
`SFCError`	GetRunningList( `VoidPtr` buf , `SInt32Ptr` size ) GetRunningList( `SFXBufferPtr` buf ) 現在実行中のアプレットの ID のリストを取得します。
static `SFBAppletCtlSmp`	NewInstance( `Void` ) SFBAppletCtl クラスのインスタンスを生成します。
`SFCError`	Start( `AEECLSID` clsid , `VoidPtr` buf , `SInt32Ptr` size ) Start( `AEECLSID` clsid , `SFXBufferPtr` buf ) 指定したアプレットクラスを起動します。
`SFCError`	Stop( `AEECLSID` clsid ) 現在実行中のアプレットを停止します。
`SFCError`	QueryInterface( `AEECLSID` clsid , `VoidHandle` handle ) (SFBQuery から継承) QueryInterface( `AEECLSID` clsid , `SFBBaseSmpPtr` handle ) (SFBQuery から継承) このオブジェクトからの別の API を問い合わせます。
`SFBBaseSmp`	QueryInterface( `AEECLSID` clsid ) (SFBQuery から継承) このオブジェクトからの別の API を問い合わせます。
`Void`	Self( `AEECLSID` clsidReq , `SFBQuerySmpPtr` clone , `AEECLSID` clsidImp ) (SFBQuery から継承) オブジェクトを単一インターフェースで実装するときに使います。
`SFBQuerySmp`	Self( `AEECLSID` clsidReq , `AEECLSID` clsidImp ) (SFBQuery から継承) オブジェクトを単一インターフェースで実装するときに使います。

SFBAppletCtl::BrowseFile

( 拡張子で ) 指定されたファイルタイプに関連付けられたアプレットを起動します。

[ public ]
SFCError BrowseFile(
    ACharConstPtr file   // ファイル名
    UInt32 reason        // アプレットの起動理由
);

[ public ]
SFCError BrowseFile(
    SFXAnsiStringConstRef file   // ファイル名
    UInt32 reason                // アプレットの起動理由
);

戻り値

成功したとき : SFERR_NO_ERROR
メモリ不足のとき : SFERR_NO_MEMORY
file がファイル拡張子を含んでいないとき : SFERR_INVALID_PARAM
サポートされていないとき : SFERR_UNSUPPORTED
失敗したとき : SFERR_FAILED
アプレットが終了したとき : EEXPIRED
特権を持っていないとき : EPRIVLEVEL
アプレットが無効にされているとき : EFILENOEXISTS
OEM または現在のアプリケーションがこのアプレットのロードを許可しないとき : EUNABLETOLOAD
最前面のアプリケーションが制御を解放しないとき : EITEMBUSY
file が null のとき : EBADCLASS
ファイル拡張子のハンドラがないとき : ESCHEMENOTSUPPORTED

解説

アプレットが起動され、EVT_BROWSE_FILE イベントを受け取ります。

参照

SFBAppletCtl::BrowseURL

指定された URL スキームに関連付けられたアプレットを起動します。

[ public ]
SFCError BrowseURL(
    ACharConstPtr url   // アプレットの起動に使用する URL へのポインター
    UInt32 reason       // アプレットの起動理由
);

[ public ]
SFCError BrowseURL(
    SFXAnsiStringConstRef url   // アプレットの起動に使用する URL へのポインター
    UInt32 reason               // アプレットの起動理由
);

戻り値

成功したとき : SFERR_NO_ERROR
メモリ不足のとき : SFERR_NO_MEMORY
サポートされていないとき : SFERR_UNSUPPORTED
失敗したとき : SFERR_FAILED
アプレットが終了したとき : EEXPIRED
特権を持っていないとき : EPRIVLEVEL
アプレットが無効にされているとき : EFILENOEXISTS
OEM または現在のアプリケーションがこのアプレットのロードを許可しないとき : EUNABLETOLOAD
最前面のアプリケーションが制御を解放しないとき : EITEMBUSY
url が null のとき : EBADCLASS
URL スキームのハンドラがないとき : ESCHEMENOTSUPPORTED

解説

アプレットが起動され、EVT_BROWSE_URL イベントを受け取ります。

参照

SFBAppletCtl::CanStart

起動情報を与えた指定のアプレットが起動できるか判断します。

[ public ]
SFCError CanStart(
    AEECLSID clsid   // アプレットの ClassID
    VoidPtr buf      // AppStartInfo 型の構造体への有効なポインター
    SInt32Ptr size   // buf のサイズ ( バイト数 ) 
);

[ public ]
SFCError CanStart(
    AEECLSID clsid     // アプレットの ClassID
    SFXBufferPtr buf   // AppStartInfo 型の構造体への有効なポインター
);

戻り値

成功したとき : SFERR_NO_ERROR
引数が不正なとき : SFERR_INVALID_PARAM
メモリ不足のとき : SFERR_NO_MEMORY
サポートされていないとき : SFERR_UNSUPPORTED
失敗したとき : SFERR_FAILED
アプレットが終了したとき : EEXPIRED
アプレットが無効にされているとき : EFILENOEXISTS
OEM または現在のアプリケーションがこのアプレットのロードを許可しないとき : EUNABLETOLOAD
アプリケーションがアプレットの起動を許可しないとき : EITEMBUSY
url が null のとき : EBADCLASS

解説

起動中のアプレットがスクリーンセーバーアプレットである ( SSA_SSAVER フラグが設定されている ) 場合、最前面のアプレットに EVT_APP_NO_CLOSE( EVT_BUSY ) が送られます。

参照

BREW API IAPPLETCTL_CanStart | SFBShell::StartApplet

SFBAppletCtl::Control

アプレットをコントロールします。

[ public ]
SFCError Control(
    AEECLSID clsid     // アプレットの ClassID
    SInt32 operation   // 指定されたアプレットクラスに対して実行する操作
    VoidPtr buf        // リターン時に、対応する情報 
    SInt32Ptr size     // buf のサイズ ( バイト数 ) 
);

[ public ]
SFCError Control(
    AEECLSID clsid     // アプレットの ClassID
    SInt32 operation   // 指定されたアプレットクラスに対して実行する操作
    SFXBufferPtr buf   // リターン時に、対応する情報
);

戻り値

成功したとき : SFERR_NO_ERROR
引数が不正なとき : SFERR_INVALID_PARAM
メモリ不足のとき : SFERR_NO_MEMORY
サポートされていないとき : SFERR_UNSUPPORTED
失敗したとき : SFERR_FAILED
特権を持っていないとき : EPRIVLEVEL
アプレットが終了したとき : EEXPIRED
アプレットが無効にされているとき : EFILENOEXISTS
OEM または現在のアプリケーションがこのアプレットのロードを許可しないとき : EUNABLETOLOAD
OEM コードがアプリケーションの起動を許可しないとき : ENOTALLOWED
最前面のアプリケーションが制御を解放しないとき : EITEMBUSY
指定した clsid が、現在実行中またはロード済みのアプレットでないとき : EBADCLASS

参照

BREW API IAPPLETCTL_Control | SFBShell::StartApplet | SFBAppletCtl::Start | SFBAppletCtl::Stop

SFBAppletCtl::GetRunningInfo

現在実行中のアプリケーションに関する特定の情報を取得します。

[ public ]
SFCError GetRunningInfo(
    AEECLSID clsid    // アプレットの ClassID
    AEEAppItem item   // 情報が必要な項目
    VoidPtr buf       // 値が返されたときに、対応する情報が格納される 
    SInt32Ptr size    // buf のサイズ ( バイト数 ) 
);

[ public ]
SFCError GetRunningInfo(
    AEECLSID clsid     // アプレットの ClassID
    AEEAppItem item    // 情報が必要な項目
    SFXBufferPtr buf   // 値が返されたときに、対応する情報が格納される
);

戻り値

成功したとき : SFERR_NO_ERROR
引数が不正なとき : SFERR_INVALID_PARAM
メモリ不足のとき : SFERR_NO_MEMORY
サポートされていないとき : SFERR_UNSUPPORTED
失敗したとき : SFERR_FAILED
指定した clsid が、現在実行中またはロード済みのアプレットでないとき : EBADCLASS

参照

BREW API IAPPLETCTL_GetRunningInfo | SFBAppletCtl::GetRunningList | SFBShell::EnumNextApplet

SFBAppletCtl::GetRunningList

現在実行中のアプレットの ID のリストを取得します。

[ public ]
SFCError GetRunningList(
    VoidPtr buf      // 現在実行中のアプリケーション ID のリストが格納される
    SInt32Ptr size   // buf のサイズ ( バイト数 ) 
);

[ public ]
SFCError GetRunningList(
    SFXBufferPtr buf   // 現在実行中のアプリケーション ID のリストが格納される
);

戻り値

成功したとき : SFERR_NO_ERROR
引数が不正なとき : SFERR_INVALID_PARAM
失敗したとき : SFERR_FAILED

参照

BREW API IAPPLETCTL_GetRunningList | SFBAppletCtl::GetRunningInfo

SFBAppletCtl::NewInstance

SFBAppletCtl クラスのインスタンスを生成します。

[ public, static ]
SFBAppletCtlSmp NewInstance(Void);

SFBAppletCtl::Start

指定したアプレットクラスを起動します。

[ public ]
SFCError Start(
    AEECLSID clsid   // 起動するアプレットの ClassID
    VoidPtr buf      // AppStartInfo 型の構造体への有効なポインター
    SInt32Ptr size   // buf のサイズ ( バイト数 ) 
);

[ public ]
SFCError Start(
    AEECLSID clsid     // 起動するアプレットの ClassID
    SFXBufferPtr buf   // AppStartInfo 型の構造体への有効なポインター
);

戻り値

成功したとき : SFERR_NO_ERROR
引数が不正なとき : SFERR_INVALID_PARAM
メモリ不足のとき : SFERR_NO_MEMORY
サポートされていないとき : SFERR_UNSUPPORTED
失敗したとき : SFERR_FAILED
指定したシェルクラスが無効なとき : EBADCLASS
アプレットが終了したとき : EEXPIRED
特権を持っていないとき : EPRIVLEVEL
アプレットが無効にされているとき : EFILENOEXISTS
OEM または現在のアプリケーションがこのアプレットのロードを許可しないとき : EUNABLETOLOAD
OEM コードがアプリケーションの起動を許可しないとき : ENOTALLOWED
最前面のアプリケーションが制御を解放しないとき : EITEMBUSY

参照

BREW API IAPPLETCTL_Start | SFBShell::StartApplet

SFBAppletCtl::Stop

現在実行中のアプレットを停止します。

[ public ]
SFCError Stop(
    AEECLSID clsid   // 現在実行中のアプレットの ClassID
);

戻り値

成功したとき : SFERR_NO_ERROR
特権を持っていないとき : EPRIVLEVEL
指定した clsid が、現在実行中のアプレットでないとき : EPRIVLEVEL

参照

BREW API IAPPLETCTL_Stop | SFBShell::StartApplet | SFBAppletCtl::Start