Collapse all Symbian^3 Product Developer Library

CHciUtil Class Reference

class CHciUtil : public CBase

Inherits from

CHciUtil
- CBase

Public Member Functions
	~CHciUtil()
IMPORT_C void	CloseIniFile()
IMPORT_C void	DestroyedImplementation(TUid)
IMPORT_C TUid	GetUidFromFileL(const TDesC &, const TDesC &)
IMPORT_C TUint	GetValueFromFileL(const TDesC &, const TDesC &)
IMPORT_C TAny *	LoadImplementationL(TUid, TInt)
IMPORT_C TAny *	LoadImplementationL(TUid, TUid, TInt)
IMPORT_C CHciUtil *	NewL(const TDesC &)
IMPORT_C void	OpenIniFileL()
IMPORT_C void	OpenIniFileL(const TDesC &, const TDesC &)
IMPORT_C TInt	SymbianErrorCode(THCIErrorCode)

Private Member Functions
	CHciUtil()
void	ConstructL(const TDesC &)
TUid	FormatUidL(TPtrC &)
TUint	FormatValueL(TPtrC &)
void	GetFromFileL(const TDesC &, const TDesC &, TPtrC &)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Private Attributes
TBuf< KMaxHciUtilComponentName >	iCompName
CIniFileData *	iIniFile

Constructor & Destructor Documentation

CHciUtil()

CHciUtil

(

)

[private]

~CHciUtil()

IMPORT_C

~CHciUtil

(

)

Member Functions Documentation

CloseIniFile()

IMPORT_C void

CloseIniFile

(

)

Closes any ini file currently open.

ConstructL(const TDesC &)

void

ConstructL

(

const TDesC &

aComponentName

)

[private]

Parameters

const TDesC & aComponentName

DestroyedImplementation(TUid)

IMPORT_C void

DestroyedImplementation

(

TUid

aKey

)

[static]

Indicates that a specific ECom instance should be destroyed.

Parameters

TUid aKey

FormatUidL(TPtrC &)

TUid

FormatUidL

(

TPtrC &

aDes

)

[private]

Parameters

TPtrC & aDes

FormatValueL(TPtrC &)

TUint

FormatValueL

(

TPtrC &

aDes

)

[private]

Parameters

TPtrC & aDes

GetFromFileL(const TDesC &, const TDesC &, TPtrC &)

void	GetFromFileL	(	const TDesC &	aSection,
			const TDesC &	aTag,
			TPtrC &	aRetText
		)	[private]

Parameters

const TDesC & aSection
const TDesC & aTag
TPtrC & aRetText

GetUidFromFileL(const TDesC &, const TDesC &)

IMPORT_C TUid	GetUidFromFileL	(	const TDesC &	aSection,
			const TDesC &	aTag
		)

Gets a TUid from an opened ini file.

Parameters

const TDesC & aSection	The section name under which the tag for the UID is to be found.
const TDesC & aTag	The tag which marks up the UID that is required.

GetValueFromFileL(const TDesC &, const TDesC &)

IMPORT_C TUint	GetValueFromFileL	(	const TDesC &	aSection,
			const TDesC &	aTag
		)

Gets a numeric value from an opened ini file.

Parameters

const TDesC & aSection	The section name under which the tag for the UID is to be found.
const TDesC & aTag	The tag which marks up the UID that is required.

LoadImplementationL(TUid, TInt)

IMPORT_C TAny *	LoadImplementationL	(	TUid	aIfUid,
			TInt	aKeyOffset
		)	[static]

Utility for loading HCI plugins. Attempts to create a plugin instance with the appropriate interface.

leave: KErrNotFound If no ECom plugins supporting the supplied interface UID are available.

leave: KErrArgument If more than one ECom plugin implementations are providing the specified interface.

Parameters

TUid aIfUid	The ECom interface UID to create an instance of.
TInt aKeyOffset	The key offset.

LoadImplementationL(TUid, TUid, TInt)

IMPORT_C TAny *	LoadImplementationL	(	TUid	aIfUid,
			TUid	aImplUid,
			TInt	aKeyOffset
		)	[static]

Parameters

TUid aIfUid
TUid aImplUid
TInt aKeyOffset

NewL(const TDesC &)

IMPORT_C CHciUtil *

NewL

(

const TDesC &

aComponentName

)

[static]

Creates an instance of CHciUtil for working with a HCI config file for a particular component.

Parameters

const TDesC & aComponentName

The name of the component using the instance.

OpenIniFileL()

IMPORT_C void

OpenIniFileL

(

)

Opens an ini file based on the name of the component (provided when the CHciUtil instance was created.) It looks for the file in the default path.

panic: KHciUtilPanic EAlreadyAnInFileOpen If the CHciUtil instance already has an ini file opened.

OpenIniFileL(const TDesC &, const TDesC &)

IMPORT_C void	OpenIniFileL	(	const TDesC &	aPath,
			const TDesC &	aFile
		)

Opens an ini file with a particular name in a given path location.

panic: KHciUtilPanic EAlreadyAnIniFileOpen If the CHciUtil instance already has an ini file opened.

Parameters

const TDesC & aPath	The path the ini file is located.
const TDesC & aFile	The name of the ini file to be opened.

SymbianErrorCode(THCIErrorCode)

IMPORT_C TInt

SymbianErrorCode

(

THCIErrorCode

aErrorCode

)

[static]

A Method that converts a HCI error code (as defined by the Bluetooth specification) into a Symbian error code.

Parameters

THCIErrorCode aErrorCode

The HCI error code to be converted

Member Data Documentation

TBuf< KMaxHciUtilComponentName > iCompName

TBuf< KMaxHciUtilComponentName >

iCompName

[private]

CIniFileData * iIniFile

CIniFileData *

iIniFile

[private]