TBTLocalDevice Class Reference

#include <btdevice.h>

Link against: btdevice.lib

class TBTLocalDevice

Protected Member Enumerations
enum	anonymous { EAddress, ECoD, EDeviceName, EPowerSetting, ..., EAcceptPairedOnlyMode }

Public Member Functions
	TBTLocalDevice()
IMPORT_C TBool	AFHChannelAssessmentMode()
IMPORT_C TBool	AcceptPairedOnlyMode()
IMPORT_C const TBTDevAddr &	Address()
IMPORT_C TUint32	DeviceClass()
IMPORT_C const TDesC8 &	DeviceName()
IMPORT_C TBool	IsValidAFHChannelAssessmentMode()
IMPORT_C TBool	IsValidAcceptPairedOnlyMode()
IMPORT_C TBool	IsValidAddress()
IMPORT_C TBool	IsValidDeviceClass()
IMPORT_C TBool	IsValidDeviceName()
IMPORT_C TBool	IsValidLimitedDiscoverable()
IMPORT_C TBool	IsValidPowerSetting()
IMPORT_C TBool	IsValidScanEnable()
IMPORT_C TBool	LimitedDiscoverable()
IMPORT_C TUint8	PowerSetting()
IMPORT_C THCIScanEnable	ScanEnable()
IMPORT_C void	SetAFHChannelAssessmentMode(TBool)
IMPORT_C void	SetAcceptPairedOnlyMode(TBool)
IMPORT_C void	SetAddress(const TBTDevAddr &)
IMPORT_C void	SetDeviceClass(TUint32)
IMPORT_C void	SetDeviceName(const TDesC8 &)
IMPORT_C void	SetLimitedDiscoverable(TBool)
IMPORT_C void	SetPowerSetting(TUint8)
IMPORT_C void	SetScanEnable(THCIScanEnable)

Detailed Description

Class used to exchange the local settings with the Registry server.

Not a complete set of details of the local device

Member Enumeration Documentation

Enum anonymous

Enumerator	Value	Description
EAddress	0x0001
ECoD	0x0002
EDeviceName	0x0004
EPowerSetting	0x0008
EScanEnable	0x0010
ELimitedDiscoverable	0x0020
EAFHChannelAssessmentMode	0x0040
EAcceptPairedOnlyMode	0x0080

Constructor & Destructor Documentation

TBTLocalDevice ( )

IMPORT_C

TBTLocalDevice

(

)

Constructor

Member Function Documentation

AFHChannelAssessmentMode ( )

IMPORT_C TBool

AFHChannelAssessmentMode

(

)

const

Get the AFH channel assessment mode.

Returns: ETrue if local device has AFHChannelModeAssessment switched on (i.e. available for use), otherwise EFalse

AcceptPairedOnlyMode ( )

IMPORT_C TBool

AcceptPairedOnlyMode

(

)

const

Get the setting for whether to accept all incoming connections or just those from paired devices. Note this is in fact a setting in the stack not the controller.

Returns: ETrue if local device is set only to accept incoming connections from paired devices, otherwise EFalse

Address ( )

IMPORT_C const TBTDevAddr &

Address

(

)

const

Get the address of the local device.

Returns: Address of local device

DeviceClass ( )

IMPORT_C TUint32

DeviceClass

(

)

const

Get the device class.

DeviceName ( )

IMPORT_C const TDesC8 &

DeviceName

(

)

const

Get the device name.

Returns: name of local device

IsValidAFHChannelAssessmentMode ( )

IMPORT_C TBool

IsValidAFHChannelAssessmentMode

(

)

const

Denotes whether the AFH channel assessment mode has been set.

Returns: ETrue if AFH channel assessment mode has been set

IsValidAcceptPairedOnlyMode ( )

IMPORT_C TBool

IsValidAcceptPairedOnlyMode

(

)

const

Denotes whether "Accept Paired Only Mode" has been set.

Returns: ETrue if "Accept Paired Only Mode" has been set

IsValidAddress ( )

IMPORT_C TBool

IsValidAddress

(

)

const

Denotes whether the address has been set.

Returns: ETrue if Address has been set

IsValidDeviceClass ( )

IMPORT_C TBool

IsValidDeviceClass

(

)

const

Denotes whether the device class has been set.

Returns: ETrue if DeviceClass has been set

IsValidDeviceName ( )

IMPORT_C TBool

IsValidDeviceName

(

)

const

Denotes whether the device name has been set.

Returns: ETrue if DeviceName has been set

IsValidLimitedDiscoverable ( )

IMPORT_C TBool

IsValidLimitedDiscoverable

(

)

const

Denotes whether the limited discoverable mode has been set.

Returns: ETrue if LimitedDiscoverble has been set

IsValidPowerSetting ( )

IMPORT_C TBool

IsValidPowerSetting

(

)

const

Denotes whether the power setting has been set.

Returns: ETrue if Power setting has been set

IsValidScanEnable ( )

IMPORT_C TBool

IsValidScanEnable

(

)

const

Denotes whether the scan enable has been set.

Returns: ETrue if ScanEnable has been set

LimitedDiscoverable ( )

IMPORT_C TBool

LimitedDiscoverable

(

)

const

Get the limited discoverable mode.

Returns: ETrue if local device is limited discoverable, otherwise EFalse

PowerSetting ( )

IMPORT_C TUint8

PowerSetting

(

)

const

Get the power setting.

Returns: The power setting of the local device

ScanEnable ( )

IMPORT_C THCIScanEnable

ScanEnable

(

)

const

Get the scanning mode.

Returns: the scanning of the local device

SetAFHChannelAssessmentMode ( TBool )

IMPORT_C void

SetAFHChannelAssessmentMode

(

TBool

aOn

)

Set the AFH channel assessment mode.

Parameter	Description
aOn	the local device channel assessment mode is switched on (available for use)

SetAcceptPairedOnlyMode ( TBool )

IMPORT_C void

SetAcceptPairedOnlyMode

(

TBool

aOn

)

Set the paired device only mode. This is a stack setting which makes the decision as to whether to accept connection requests ONLY from paired devices (rejecting connection requests from unpaired devices).

Parameter	Description
aOn	the local stack will ONLY accept connection requests from paired devices

SetAddress ( const TBTDevAddr & )

IMPORT_C void

SetAddress

(

const TBTDevAddr &

aAddr

)

Set the device address.

Parameter	Description
aAddr	the local device address

SetDeviceClass ( TUint32 )

IMPORT_C void

SetDeviceClass

(

TUint32

aCod

)

Set the device class.

Parameter	Description
aCod	the local device class

SetDeviceName ( const TDesC8 & )

IMPORT_C void

SetDeviceName

(

const TDesC8 &

aName

)

Set the device name.

Parameter	Description
aName	the local device name

SetLimitedDiscoverable ( TBool )

IMPORT_C void

SetLimitedDiscoverable

(

TBool

aOn

)

Set limited discoverable mode.

Parameter	Description
aOn	the local device limited discoverable-ness

SetPowerSetting ( TUint8 )

IMPORT_C void

SetPowerSetting

(

TUint8

aPowerSetting

)

Set the power setting.

Parameter	Description
aPowerSetting	the local device power setting

SetScanEnable ( THCIScanEnable )

IMPORT_C void

SetScanEnable

(

THCIScanEnable

aEnable

)

Enable local device scanning.

Parameter	Description
aEnable	the local device scanning