BSUL::CIniSecIter8 Class Reference

#include "inifile.h"

Link against: bsulinifile.lib

class BSUL::CIniSecIter8 : public CBase

Inherits from

BSUL::CIniSecIter8

Public Member Functions
	~CIniSecIter8()
IMPORT_C TBool	End()
IMPORT_C CIniSecIter8 *	NewL(const TDesC8 &, const CIniDocument8 *)
IMPORT_C TBool	Next(TPtrC8 &, TPtrC8 &)
IMPORT_C void	Reset()

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()

Detailed Description

Section iterator for 8 bit ini file. This class provides an iterator to navigate through the settings within a section inside an 8 bit ini file.

Constructor & Destructor Documentation

~CIniSecIter8 ( )

IMPORT_C

~CIniSecIter8

(

)

Destructor

Member Function Documentation

End ( )

IMPORT_C TBool

End

(

)

Look ahead in the section to check whether there is still any keyvalue pair in the section to be read

Returns: ETrue if it is already end of section EFalse indicating the next keyvalue pair exists

NewL ( const TDesC8 &, const CIniDocument8 * )

IMPORT_C CIniSecIter8 *	NewL	(	const TDesC8 &	aSectionName,
			const CIniDocument8 *	aIniDocument
		)	[static]

Creates a 8 bit section content iterator this iterator is used to navigate through the key value pairs within the section.Useful when the number of keys within the section is unknown.

leave: KErrNoMemory if not enough memory KErrArgument if aIniDocument is NULL

Parameter	Description
aSectionName	the name of the section to iterate
aIniDocument	the document object containing the section

Returns: A pointer to a newly created CIniSecIter8 object

Next ( TPtrC8 &, TPtrC8 & )

IMPORT_C TBool	Next	(	TPtrC8 &	aKey,
			TPtrC8 &	aValue
		)

Return the next key value pair within the section

Post-condition: the iterator points to the next available keyvalue pair the aKeyName points to the key name the aKeyValue points to the key value

Parameter	Description
aKey	a pointer to contain the key name
aValue	a pointer to contain the key value

Returns: ETrue if there are keyvalue pairs to return EFalse if it is already end of section

Reset ( )

IMPORT_C void

Reset

(

)

Reset the iterator to point to the first keypair value within the section.

Post-condition: the iterator now points to first keypair in the section