SFBItemStore

Wrapper Class for the IItemStore interface.

#include <SFBItemStore.h.hpp>

class SFBItemStore : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBItemStore)

Inheritance diagram

Version

Introduced BREW Client 3.1.5SP01

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

Reference

BREW API IItemStore

Member

Public Functions
`SFCError`	Get( `ACharPtr` buffer , `SInt32` length , `SInt32Ptr` lenreq ) Get the value of specified item.
`SFCError`	Get( `SFXAnsiStringPtr` item ) Get the value of specified item.
static `SFBItemStoreSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBItemStore instance.
static `SFBItemStoreSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBItemStore instance.
`SFCError`	OnChange( `SFBSignalSmpConstRef` signal ) Register a signal which is set whenever the items changes.
`SFCError`	Set( `ACharConstPtr` item ) Set the value of item to the specified string.
`SFCError`	Set( `SFXAnsiStringConstRef` item ) Set the value of item to the specified string.
`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.

SFBItemStore::Get

Get the value of specified item.

[ public ]
SFCError Get(
    ACharPtr buffer    // pointer to buffer to which item is copied
    SInt32 length      // the size of pszItemBuf in bytes
    SInt32Ptr lenreq   // pointer to the full length of the item
);

[ public ]
SFCError Get(
    SFXAnsiStringPtr item   // the string to which item is copied
);

Reference

BREW API IItemStore_Get

SFBItemStore::NewInstance

Create a new SFBItemStore instance.

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

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

SFBItemStore::OnChange

[ public ]
SFCError OnChange(
    SFBSignalSmpConstRef signal   // smart pointer to signal which will be set when the item changes
);

Reference

BREW API IItemStore_OnChange

SFBItemStore::Set

Set the value of item to the specified string.

[ public ]
SFCError Set(
    ACharConstPtr item   // item value
);

[ public ]
SFCError Set(
    SFXAnsiStringConstRef item   // item value
);

Reference

BREW API IItemStore_Set