SFBSMSStorage2

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

#include <SFBSMSStorage2.h.hpp>

class SFBSMSStorage2 : public SFBSMSStorage;

SFMTYPEDEFWRAPPER(SFBSMSStorage2)

継承図

バージョン

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

参照

BREW API ISMSStorage2

メンバ

パブリック関数
`Void`	AutoStoreMsg( `AEESMSClass` smsclass , `AEESMSStorageType` type , `SFXCallbackPtr` callback , `UInt32Ptr` error ) 指定されたメッセージクラスのメッセージの自動格納ステータスを有効または無効にします。
static `SFBSMSStorage2Smp`	NewInstance( `SFCErrorPtr` exception = null ) SFBSMSStorage2 インスタンスを生成します。
static `SFBSMSStorage2Smp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) SFBSMSStorage2 インスタンスを生成します。
`Void`	DeleteAll( `AEESMSStorageType` type , `SFXCallbackPtr` callback , `UInt32Ptr` error ) (SFBSMSStorage から継承) 指定したストレージタイプからすべてのメッセージを削除します。
`Void`	DeleteMsg( `AEESMSStorageType` type , `UInt32` index , `SFXCallbackPtr` callback , `UInt32Ptr` error ) (SFBSMSStorage から継承) 指定されたストレージタイプから指定されたインデックスを持つメッセージを削除します。
`Void`	DeleteMsgTag( `AEESMSStorageType` type , `AEESMSTag` tag , `SFXCallbackPtr` callback , `UInt32Ptr` error ) (SFBSMSStorage から継承) 指定されたストレージタイプから指定されたタグを持つすべてのメッセージを削除します。
`Void`	EnumMsgInit( `AEESMSStorageType` type , `AEESMSTag` tag , `SFXCallbackPtr` callback , `UInt32Ptr` error ) (SFBSMSStorage から継承) 指定されたタグのメッセージを列挙するために、指定されたストレージタイプを初期設定します。
`Void`	EnumNextMsg( `AEESMSStorageType` type , `SFXCallbackPtr` callback , `UInt32Ptr` index , `SFBSMSMsgSmpPtr` message , `UInt32Ptr` error ) (SFBSMSStorage から継承) SFBSMSStorage::EnumMsgInit に指定されている列挙条件に適合する指定されたストレージタイプの次のメッセージに関する情報を取得します。
`Void`	GetStorageStatus( `AEESMSStorageType` type , `AEESMSTag` tag , `SFXCallbackPtr` callback , `AEESMSStorageStatus*` status , `UInt32Ptr` error ) (SFBSMSStorage から継承) 指定されたストレージタイプに対応するストレージのステータスを取得します。
`SFCError`	QueryInterface( `AEECLSID` clsid , `VoidHandle` handle ) (SFBQuery から継承) このオブジェクトからの別の API を問い合わせます。
`SFCError`	QueryInterface( `AEECLSID` clsid , `SFBBaseSmpPtr` handle ) (SFBQuery から継承) このオブジェクトからの別の API を問い合わせます。
`SFBBaseSmp`	QueryInterface( `AEECLSID` clsid ) (SFBQuery から継承) このオブジェクトからの別の API を問い合わせます。
`Void`	ReadMsg( `AEESMSStorageType` type , `UInt32` index , `SFXCallbackPtr` callback , `SFBSMSMsgSmpPtr` message , `UInt32Ptr` error ) (SFBSMSStorage から継承) 指定したストレージタイプからメッセージを読み出します。
`Void`	Self( `AEECLSID` clsidReq , `SFBQuerySmpPtr` clone , `AEECLSID` clsidImp ) (SFBQuery から継承) オブジェクトを単一インターフェースで実装するときに使います。
`SFBQuerySmp`	Self( `AEECLSID` clsidReq , `AEECLSID` clsidImp ) (SFBQuery から継承) オブジェクトを単一インターフェースで実装するときに使います。
`Void`	StoreMsg( `AEESMSStorageType` type , `SFBSMSMsgSmpConstRef` message , `SFXCallbackPtr` callback , `UInt32Ptr` index , `UInt32Ptr` error ) (SFBSMSStorage から継承) 指定したストレージタイプにメッセージを保存します。
`Void`	UpdateMsg( `AEESMSStorageType` type , `UInt32` index , `SFBSMSMsgSmpConstRef` message , `SFXCallbackPtr` callback , `UInt32Ptr` error ) (SFBSMSStorage から継承) 指定されたストレージタイプとインデックスにあるメッセージを更新します。

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

SFBSMSStorage2::AutoStoreMsg

指定されたメッセージクラスのメッセージの自動格納ステータスを有効または無効にします。

[ public ]
Void AutoStoreMsg(
    AEESMSClass smsclass      // メッセージクラス
    AEESMSStorageType type    // ストレージタイプ
    SFXCallbackPtr callback   // コールバック
    UInt32Ptr error           // エラーのプレースホルダー
);

解説

自動的に格納されるメッセージのストレージタイプとストレージインデックス情報は、それぞれ MSGOPT_AUTO_STORAGE_TYPE と MSGOPT_AUTO_STORAGE_INDEX で指定します。アプリケーションは、希望のメッセージクラスとストレージタイプ AEESMS_STORAGE_NONE を指定してこのメソッドをコールし、あるクラスのメッセージの自動格納を無効にできます。

error は、トランザクション全体を通して有効でなければなりません。これらは SFBSMSStorage2 の実装によって読み込まれ、コールバック関数で確認することができます。

自動格納ステータスの変更に成功した場合、 SFBSMSStorage2 インタフェースオブジェクトを登録したクライアントには、 SFBSMSStorage2 がサポートする SFBModel インタフェースを使用して EVT_MDL_SMSSTORAGE_CLASS_XXX_AUTOSTORE イベントが送信されます。

メッセージクラスによっては "自動メッセージ格納" がデフォルトのプラットフォーム設定となっていることがあり、そのクラスのメッセージは自動的に格納されます。アプリケーションは、メッセージクラスに対して AEESMS_STORAGE_NONE. を指定してこの API をコールすることにより、デフォルトのプラットフォーム設定を上書きできます。

参照

BREW API ISMSSTORAGE2_AutoStoreMsg

SFBSMSStorage2::NewInstance

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

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

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