Collapse all Symbian^3 Application Developer Library

RBTEng Class Reference

class RBTEng : public RSessionBase

?more_complete_description

bteng*.lib

Since: S60 v3.2

Inherits from

RBTEng
- RSessionBase
  - RHandleBase

Public Member Functions
	RBTEng ()
TInt	CancelConnectDevice (const TBTDevAddr &)
TInt	CancelNotifyConnectionEvents ()
void	CancelPairDevice ()
TInt	Connect ()
TInt	ConnectDevice (const TBTDevAddr &, const TBTDeviceClass &)
TInt	DisconnectDevice (const TBTDevAddr &, TBTDisconnectType )
TInt	GetConnectedAddresses ( TDes8 &, TBTEngParamPkg &)
TInt	IsDeviceConnectable (const TBTDevAddr &, const TBTDeviceClass &, TBool &)
TInt	IsDeviceConnected (const TBTDevAddr &, TBTEngConnectionStatus &)
TInt	NotifyConnectionEvents ( TDes8 &, TRequestStatus &)
void	PairDevice (const TBTDevAddrPckgBuf &, const TUint32 &, TRequestStatus &)
TInt	PrepareDiscovery ()
TInt	SetPairingObserver (const TBTDevAddr &, TBool )
TInt	SetPowerState (const TBTPowerStateValue , const TBool )
TInt	SetVisibilityMode (const TBTVisibilityMode , const TInt )
TVersion	Version ()

Inherited Functions
	RHandleBase::Attributes()const
	RHandleBase::BTraceId()const
	RHandleBase::Close()
	RHandleBase::DoExtendedClose()
	RHandleBase::Duplicate(const RThread &,TOwnerType)
	RHandleBase::FullName()const
	RHandleBase::FullName(TDes &)const
	RHandleBase::Handle()const
	RHandleBase::HandleInfo(THandleInfo *)
	RHandleBase::Name()const
	RHandleBase::NotifyDestruction(TRequestStatus &)
	RHandleBase::Open(const TFindHandleBase &,TOwnerType)
	RHandleBase::OpenByName(const TDesC &,TOwnerType,TInt)
	RHandleBase::RHandleBase()
	RHandleBase::RHandleBase(TInt)
	RHandleBase::SetHandle(TInt)
	RHandleBase::SetHandleNC(TInt)
	RSessionBase::CreateSession(RServer2,const TVersion &)
	RSessionBase::CreateSession(RServer2,const TVersion &,TInt)
	RSessionBase::CreateSession(RServer2,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy ,TRequestStatus )
	RSessionBase::CreateSession(const TDesC &,const TVersion &)
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt)
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy ,TRequestStatus )
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TRequestStatus *)
	RSessionBase::Open(RMessagePtr2,TInt,TOwnerType)
	RSessionBase::Open(RMessagePtr2,TInt,const TSecurityPolicy &,TOwnerType)
	RSessionBase::Open(TInt,TOwnerType)
	RSessionBase::Open(TInt,const TSecurityPolicy &,TOwnerType)
	RSessionBase::Send(TInt)const
	RSessionBase::Send(TInt,const TIpcArgs &)const
	RSessionBase::SendReceive(TInt)const
	RSessionBase::SendReceive(TInt,TRequestStatus &)const
	RSessionBase::SendReceive(TInt,const TIpcArgs &)const
	RSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
	RSessionBase::SetReturnedHandle(TInt)
	RSessionBase::SetReturnedHandle(TInt,RHandleBase &)
	RSessionBase::SetReturnedHandle(TInt,const TSecurityPolicy &)
	RSessionBase::ShareAuto()
	RSessionBase::ShareProtected()

Inherited Enumerations
	RHandleBase:TAttributes
	RSessionBase:TAttachMode

Inherited Attributes
	RHandleBase::iHandle

Constructor & Destructor Documentation

RBTEng()

RBTEng

(

)

Constructor.

Since: S60 v3.2

Member Functions Documentation

CancelConnectDevice(const TBTDevAddr &)

TInt

CancelConnectDevice

(

const TBTDevAddr &

aAddr

)

?description

Since: S60 v3.2

Parameters

const TBTDevAddr & aAddr

?description

CancelNotifyConnectionEvents()

TInt

CancelNotifyConnectionEvents

(

)

?description

Since: S60 v3.2

CancelPairDevice()

void

CancelPairDevice

(

)

Cancels an outstanding pair request

Connect()

TInt

Connect

(

)

?description

Since: S60 v3.2

ConnectDevice(const TBTDevAddr &, const TBTDeviceClass &)

TInt	ConnectDevice	(	const TBTDevAddr &	aAddr,
			const TBTDeviceClass &	aDeviceClass
		)

?description

Since: S60 v3.2

Parameters

const TBTDevAddr & aAddr	?description
const TBTDeviceClass & aDeviceClass

DisconnectDevice(const TBTDevAddr &, TBTDisconnectType)

TInt	DisconnectDevice	(	const TBTDevAddr &	aAddr,
			TBTDisconnectType	aDiscType
		)

?description

Since: S60 v3.2

Parameters

const TBTDevAddr & aAddr	?description
TBTDisconnectType aDiscType

GetConnectedAddresses(TDes8 &, TBTEngParamPkg &)

TInt	GetConnectedAddresses	(	TDes8 &	aArrayPkg,
			TBTEngParamPkg &	aProfilePkg
		)

?description

Since: S60 v3.2

Parameters

TDes8 & aArrayPkg
TBTEngParamPkg & aProfilePkg

IsDeviceConnectable(const TBTDevAddr &, const TBTDeviceClass &, TBool &)

TInt	IsDeviceConnectable	(	const TBTDevAddr &	aAddr,
			const TBTDeviceClass &	aDeviceClass,
			TBool &	aConnectable
		)

?description

Since: S60 v5.1

Parameters

const TBTDevAddr & aAddr	?description
const TBTDeviceClass & aDeviceClass
TBool & aConnectable

IsDeviceConnected(const TBTDevAddr &, TBTEngConnectionStatus &)

TInt	IsDeviceConnected	(	const TBTDevAddr &	aAddr,
			TBTEngConnectionStatus &	aConnected
		)

?description

Since: S60 v3.2

Parameters

const TBTDevAddr & aAddr	?description
TBTEngConnectionStatus & aConnected

NotifyConnectionEvents(TDes8 &, TRequestStatus &)

TInt	NotifyConnectionEvents	(	TDes8 &	aEvent,
			TRequestStatus &	aStatus
		)

?description

Since: S60 v3.2

Parameters

TDes8 & aEvent	?description
TRequestStatus & aStatus

PairDevice(const TBTDevAddrPckgBuf &, const TUint32 &, TRequestStatus &)

void	PairDevice	(	const TBTDevAddrPckgBuf &	aAddr,
			const TUint32 &	aDeviceClass,
			TRequestStatus &	aStatus
		)

Pair a device.

Parameters

const TBTDevAddrPckgBuf & aAddr	The address of the remote device to be paired.
const TUint32 & aDeviceClass	the CoD of the device to be paired.
TRequestStatus & aStatus	contains the pair result at request completion.

PrepareDiscovery()

TInt

PrepareDiscovery

(

)

?description

Since: S60 v3.2

SetPairingObserver(const TBTDevAddr &, TBool)

TInt	SetPairingObserver	(	const TBTDevAddr &	aAddr,
			TBool	aActivate
		)

Set a pairing observer in BTEngine.

Since: S60 v3.2

Parameters

const TBTDevAddr & aAddr	The address of the remote device that is being paired.
TBool aActivate	If ETrue, the observer will be activated, otherwise the observer will be removed.

SetPowerState(const TBTPowerStateValue, const TBool)

TInt	SetPowerState	(	const TBTPowerStateValue	aState,
			const TBool	aTemp
		)

Set Bluetooth power state.

Since: S60 v3.2

Parameters

const TBTPowerStateValue aState	The new power state.
const TBool aTemp	Turn BT off after use (ETrue) or not (EFalse).

SetVisibilityMode(const TBTVisibilityMode, const TInt)

TInt	SetVisibilityMode	(	const TBTVisibilityMode	aMode,
			const TInt	aTime
		)

Set Bluetooth power state.

Since: S60 v3.2

Parameters

const TBTVisibilityMode aMode
const TInt aTime

Version()

TVersion

Version

(

)

Get the version information about the client.

Since: S60 v3.2