SFBBTDevDB

Wrapper Class for the IBTDevDB interface.

#include <SFBBTDevDB.h.hpp>

class SFBBTDevDB : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBBTDevDB)

Inheritance diagram

Version

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

Reference

BREW API IBTDevDB

Member

Public Functions
`BTResult`	Add( `BTDeviceInfo const *` deviceInfo ) Add the given device information to the Device DB.
`SFCError`	Bond( `BDAddress const ` address , `UInt08ConstPtr` pin , `Bool` initiating , `BTResult ` result , `SFXCallbackPtr` callback ) Enable application to send the PIN code to BT driver to be used for authenticating the remote device.
`BTResult`	EnumInit( `BTDevDBEnumerator *` enumerator ) Initialize the Device DB enumerator.
`BTResult`	EnumNext( `BTDBEntry *` entry ) Enumerate through the Device DB to search for entries matching certain criteria.
static `SFBBTDevDBSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBBTDevDB instance.
static `SFBBTDevDBSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBBTDevDB instance.
`BTResult`	Read( `BTDBEntry *` entry ) Read from the Device DB the entry whose BD address is specified.
`BTResult`	Remove( `BDAddress const *` address ) Remove from the Device DB the entry with matching BD address.
`BTResult`	SetNickNmae( `BDAddress const *` address , `UInt08ConstPtr` name ) Update the NickName for a particular device.
`BTResult`	SetSecurity( `BDAddress const *` address , `BTSecurityLevel` security ) Update the security setting for a particular device.
`BTResult`	SetUserValue( `BDAddress const *` address , `BTModDevField` field , `UInt16` value ) Update the User defined values 1- 4 for a particular device.
`BTResult`	Unbond( `BDAddress const *` address ) Enable application to mark a given device as not bonded.
`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.

SFBBTDevDB::Add

Add the given device information to the Device DB.

[ public ]
BTResult Add(
    BTDeviceInfo const * deviceInfo   // the device information to add to DB
);

Reference

BREW API IBTDevDB_Add

SFBBTDevDB::Bond

Enable application to send the PIN code to BT driver to be used for authenticating the remote device.

[ public ]
SFCError Bond(
    BDAddress const * address   // BD address of remote device
    UInt08ConstPtr pin          // the PIN code, in UTF-8 format
    Bool initiating             // true to indicate local device initiates bonding process
    BTResult * result           // bonding result
    SFXCallbackPtr callback     // called to deliver the result
);

Reference

BREW API IBTDevDB_Bond

SFBBTDevDB::EnumInit

Initialize the Device DB enumerator.

[ public ]
BTResult EnumInit(
    BTDevDBEnumerator * enumerator   // the criteria and data used in enumerating the DB
);

Reference

BREW API IBTDevDB_EnumInit

SFBBTDevDB::EnumNext

Enumerate through the Device DB to search for entries matching certain criteria.

[ public ]
BTResult EnumNext(
    BTDBEntry * entry   // data for the next entry matching search criteria
);

Reference

BREW API IBTDevDB_EnumNext

SFBBTDevDB::NewInstance

Create a new SFBBTDevDB instance.

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

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

SFBBTDevDB::Read

Read from the Device DB the entry whose BD address is specified.

[ public ]
BTResult Read(
    BTDBEntry * entry   // [in] the BD address to match [out] the entire entry for that BD address
);

Reference

BREW API IBTDevDB_Read

SFBBTDevDB::Remove

Remove from the Device DB the entry with matching BD address.

[ public ]
BTResult Remove(
    BDAddress const * address   // the BD address to match
);

Reference

BREW API IBTDevDB_Remove

SFBBTDevDB::SetNickNmae

Update the NickName for a particular device.

[ public ]
BTResult SetNickNmae(
    BDAddress const * address   // BD address of remote device
    UInt08ConstPtr name         // Nickname in UTF-8 format, whose length should not exceed AEEBT_MAX_LEN_NICK_NAME
);

Reference

BREW API IBTDevDB_SetNickNmae

SFBBTDevDB::SetSecurity

Update the security setting for a particular device.

[ public ]
BTResult SetSecurity(
    BDAddress const * address   // BD address of remote device
    BTSecurityLevel security    // new security setting
);

Reference

BREW API IBTDevDB_SetSecurity

SFBBTDevDB::SetUserValue

Update the User defined values 1- 4 for a particular device.

[ public ]
BTResult SetUserValue(
    BDAddress const * address   // BD address of remote device
    BTModDevField field         // AEEBT_MDF_VAL1_B/ AEEBT_MDF_VAL2_B/ AEEBT_MDF_VAL3_B/ AEEBT_MDF_VAL4_B
    UInt16 value                // user defined value to update for the device
);

Reference

BREW API IBTDevDB_SetUserValue

SFBBTDevDB::Unbond

Enable application to mark a given device as not bonded.

[ public ]
BTResult Unbond(
    BDAddress const * address   // BD address of remote device
);

Reference

BREW API IBTDevDB_Unbond