SFBSMSStorage2

Wrapper Class for the ISMSStorage2 interface.

#include <SFBSMSStorage2.h.hpp>

class SFBSMSStorage2 : public SFBSMSStorage;

SFMTYPEDEFWRAPPER(SFBSMSStorage2)

Inheritance diagram

Version

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

Reference

BREW API ISMSStorage2

Member

Public Functions
`Void`	AutoStoreMsg( `AEESMSClass` smsclass , `AEESMSStorageType` type , `SFXCallbackPtr` callback , `UInt32Ptr` error ) This method enables or disables auto storage status of the messages of the specified message class.
static `SFBSMSStorage2Smp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBSMSStorage2 instance.
static `SFBSMSStorage2Smp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBSMSStorage2 instance.
`Void`	DeleteAll( `AEESMSStorageType` type , `SFXCallbackPtr` callback , `UInt32Ptr` error ) (inherits from SFBSMSStorage) Delete all the messages from the specified storage type.
`Void`	DeleteMsg( `AEESMSStorageType` type , `UInt32` index , `SFXCallbackPtr` callback , `UInt32Ptr` error ) (inherits from SFBSMSStorage) Delete message of specified index from the specified storage type.
`Void`	DeleteMsgTag( `AEESMSStorageType` type , `AEESMSTag` tag , `SFXCallbackPtr` callback , `UInt32Ptr` error ) (inherits from SFBSMSStorage) Delete all the messages of specified tag from the specified storage type.
`Void`	EnumMsgInit( `AEESMSStorageType` type , `AEESMSTag` tag , `SFXCallbackPtr` callback , `UInt32Ptr` error ) (inherits from SFBSMSStorage) Initialize the specified storage type for enumeration of the messages of the specified tag.
`Void`	EnumNextMsg( `AEESMSStorageType` type , `SFXCallbackPtr` callback , `UInt32Ptr` index , `SFBSMSMsgSmpPtr` message , `UInt32Ptr` error ) (inherits from SFBSMSStorage) Retrieve information about next message on specified storage type that meets enumeration criteria specified in SFBSMSStorage::EnumMsgInit()
`Void`	GetStorageStatus( `AEESMSStorageType` type , `AEESMSTag` tag , `SFXCallbackPtr` callback , `AEESMSStorageStatus*` status , `UInt32Ptr` error ) (inherits from SFBSMSStorage) Return storage status corresponding to the specified storage type.
`SFCError`	QueryInterface( `AEECLSID` clsid , `VoidHandle` handle ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFCError`	QueryInterface( `AEECLSID` clsid , `SFBBaseSmpPtr` handle ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFBBaseSmp`	QueryInterface( `AEECLSID` clsid ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`Void`	ReadMsg( `AEESMSStorageType` type , `UInt32` index , `SFXCallbackPtr` callback , `SFBSMSMsgSmpPtr` message , `UInt32Ptr` error ) (inherits from SFBSMSStorage) Read a message from the specified storage type.
`Void`	Self( `AEECLSID` clsidReq , `SFBQuerySmpPtr` clone , `AEECLSID` clsidImp ) (inherits from SFBQuery) Helper macro for those implementing an object with a single interface.
`SFBQuerySmp`	Self( `AEECLSID` clsidReq , `AEECLSID` clsidImp ) (inherits from SFBQuery) Helper macro for those implementing an object with a single interface.
`Void`	StoreMsg( `AEESMSStorageType` type , `SFBSMSMsgSmpConstRef` message , `SFXCallbackPtr` callback , `UInt32Ptr` index , `UInt32Ptr` error ) (inherits from SFBSMSStorage) Store a message on the specified storage type.
`Void`	UpdateMsg( `AEESMSStorageType` type , `UInt32` index , `SFBSMSMsgSmpConstRef` message , `SFXCallbackPtr` callback , `UInt32Ptr` error ) (inherits from SFBSMSStorage) Update a message in the specified storage type and index.

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.

SFBSMSStorage2::AutoStoreMsg

This method enables or disables auto storage status of the messages of the specified message class.

[ public ]
Void AutoStoreMsg(
    AEESMSClass smsclass      // Message Class 
    AEESMSStorageType type    // Storage Type 
    SFXCallbackPtr callback   // Callback 
    UInt32Ptr error           // Place holder for error
);

Description

MSGOPT_AUTO_STORAGE_TYPE and MSGOPT_AUTO_STORAGE_INDEX respectively. An application can disable auto storage on messages of a class by calling this method with the desired message class and storage type AEESMS_STORAGE_NONE.

error must remain valid during entire transaction. These are filled by SFBSMSStorage2 implementation and can be examined in the callback function.

On successful change to auto storage status, clients registered with SFBSMSStorage2 interface objects, using SFBModel interface supported by SFBSMSStorage2, are sent EVT_MDL_SMSSTORAGE_CLASS_XXX_AUTOSTORE events.

Reference

BREW API ISMSSTORAGE2_AutoStoreMsg

SFBSMSStorage2::NewInstance

Create a new SFBSMSStorage2 instance.

[ public, static ]
SFBSMSStorage2Smp NewInstance(
    SFCErrorPtr exception = null   // Error
);

[ public, static ]
SFBSMSStorage2Smp NewInstance(
    AEECLSID id                    // Class ID
    SFCErrorPtr exception = null   // Error
);