SFBSMSStorage

Wrapper class for the ISMSStorage interface.

#include <SFBSMSStorage.h.hpp>

class SFBSMSStorage : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBSMSStorage)

Inheritance diagram

Version

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

Reference

BREW API ISMSStorage

Member

Public Functions
`SFCError`	AutoStoreMsg( `AEESMSClass` mc , `AEESMSStorageType` type , `SFXCallbackPtr` callback , `UInt32Ptr` error ) Query the passed interface pointer for AEEIID_SMSSTORAGE2 and invokes ISMSSTORAGE2_AutoStoreMsg() on successful ISMSSTORAGE_QueryInterface(AEEIID_SMSSTORAGE2).
`Void`	DeleteAll( `AEESMSStorageType` type , `SFXCallbackPtr` callback , `UInt32Ptr` error ) Delete all the messages from the specified storage type.
`Void`	DeleteMsg( `AEESMSStorageType` type , `UInt32` index , `SFXCallbackPtr` callback , `UInt32Ptr` error ) Delete message of specified index from the specified storage type.
`Void`	DeleteMsgTag( `AEESMSStorageType` type , `AEESMSTag` tag , `SFXCallbackPtr` callback , `UInt32Ptr` error ) Delete all the messages of specified tag from the specified storage type.
`Void`	EnumMsgInit( `AEESMSStorageType` type , `AEESMSTag` tag , `SFXCallbackPtr` callback , `UInt32Ptr` error ) 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 ) 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 ) Return storage status corresponding to the specified storage type.
static `SFBSMSStorageSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBSMSStorage instance.
static `SFBSMSStorageSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBSMSStorage instance.
`Void`	ReadMsg( `AEESMSStorageType` type , `UInt32` index , `SFXCallbackPtr` callback , `SFBSMSMsgSmpPtr` message , `UInt32Ptr` error ) Read a message from the specified storage type.
`Void`	StoreMsg( `AEESMSStorageType` type , `SFBSMSMsgSmpConstRef` message , `SFXCallbackPtr` callback , `UInt32Ptr` index , `UInt32Ptr` error ) Store a message on the specified storage type.
`Void`	UpdateMsg( `AEESMSStorageType` type , `UInt32` index , `SFBSMSMsgSmpConstRef` message , `SFXCallbackPtr` callback , `UInt32Ptr` error ) Update a message in the specified storage type and index.
`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`	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.

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.

SFBSMSStorage::AutoStoreMsg

Query the passed interface pointer for AEEIID_SMSSTORAGE2 and invokes ISMSSTORAGE2_AutoStoreMsg() on successful ISMSSTORAGE_QueryInterface(AEEIID_SMSSTORAGE2).

[ public ]
SFCError AutoStoreMsg(
    AEESMSClass mc            // message class
    AEESMSStorageType type    // storage type
    SFXCallbackPtr callback   // callback 
    UInt32Ptr error           // place holder for error
);

Version

Introduced BREW Client 3.1.5 SP01

Reference

BREW API ISMSStorage_AutoStoreMsg

SFBSMSStorage::DeleteAll

Delete all the messages from the specified storage type.

[ public ]
Void DeleteAll(
    AEESMSStorageType type    // storage Type
    SFXCallbackPtr callback   // callback
    UInt32Ptr error           // placeholder for error
);

Reference

BREW API ISMSSTORAGE_DeleteAll

SFBSMSStorage::DeleteMsg

Delete message of specified index from the specified storage type.

[ public ]
Void DeleteMsg(
    AEESMSStorageType type    // storage type
    UInt32 index              // message index
    SFXCallbackPtr callback   // callback
    UInt32Ptr error           // placeholder for error
);

Reference

BREW API ISMSSTORAGE_DeleteMsg

SFBSMSStorage::DeleteMsgTag

Delete all the messages of specified tag from the specified storage type.

[ public ]
Void DeleteMsgTag(
    AEESMSStorageType type    // storage type
    AEESMSTag tag             // message tag
    SFXCallbackPtr callback   // callback
    UInt32Ptr error           // placeholder for error
);

Reference

BREW API ISMSSTORAGE_DeleteMsgTag

SFBSMSStorage::EnumMsgInit

Initialize the specified storage type for enumeration of the messages of the specified tag.

[ public ]
Void EnumMsgInit(
    AEESMSStorageType type    // storage type
    AEESMSTag tag             // message tag
    SFXCallbackPtr callback   // callback
    UInt32Ptr error           // placeholder for error
);

Reference

BREW API ISMSSTORAGE_EnumMsgInit

SFBSMSStorage::EnumNextMsg

Retrieve information about next message on specified storage type that meets enumeration criteria specified in SFBSMSStorage::EnumMsgInit()

[ public ]
Void EnumNextMsg(
    AEESMSStorageType type    // storage type
    SFXCallbackPtr callback   // callback
    UInt32Ptr index           // placeholder for message index in SMS storage
    SFBSMSMsgSmpPtr message   // placeholder for pointer to SFBSMSMsg interface
    UInt32Ptr error           // placeholder for error
);

Reference

BREW API ISMSSTORAGE_EnumNextMsg

SFBSMSStorage::GetStorageStatus

Return storage status corresponding to the specified storage type.

[ public ]
Void GetStorageStatus(
    AEESMSStorageType type        // storage type
    AEESMSTag tag                 // message tag
    SFXCallbackPtr callback       // callback
    AEESMSStorageStatus* status   // placeholder for storage status
    UInt32Ptr error               // placeholder for error
);

Reference

BREW API ISMSSTORAGE_GetStorageStatus

SFBSMSStorage::NewInstance

Create a new SFBSMSStorage instance.

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

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

SFBSMSStorage::ReadMsg

Read a message from the specified storage type.

[ public ]
Void ReadMsg(
    AEESMSStorageType type    // storage type
    UInt32 index              // message index
    SFXCallbackPtr callback   // callback
    SFBSMSMsgSmpPtr message   // placeholder for pointer to ISMSMsg interface. Must be released by application
    UInt32Ptr error           // placeholder for error
);

Reference

BREW API ISMSSTORAGE_ReadMsg

SFBSMSStorage::StoreMsg

Store a message on the specified storage type.

[ public ]
Void StoreMsg(
    AEESMSStorageType type         // storage type
    SFBSMSMsgSmpConstRef message   // pointer to the SFBSMSMsg interface
    SFXCallbackPtr callback        // callback
    UInt32Ptr index                // placeholder for message index in SMS storage
    UInt32Ptr error                // placeholder for error
);

Reference

BREW API ISMSSTORAGE_StoreMsg

SFBSMSStorage::UpdateMsg

Update a message in the specified storage type and index.

[ public ]
Void UpdateMsg(
    AEESMSStorageType type         // storage type
    UInt32 index                   // message index in SMS storage
    SFBSMSMsgSmpConstRef message   // smart pointer to SFBSMSMsg class
    SFXCallbackPtr callback        // callback
    UInt32Ptr error                // place holder for error
);

Version

Introduced BREW Client 3.1.3

Reference

BREW API ISMSStorage_UpdateMsg