Collapse all Symbian^3 Application Developer Library

HPosLmDatabaseInfo Class Reference

class HPosLmDatabaseInfo

HPosLmDatabaseInfo encapsulates information about a landmark database.

eposlmdbmanlib.lib

Since: S60 3.0

Public Member Functions
IMPORT_C TChar	DatabaseDrive ()
IMPORT_C TMediaType	DatabaseMedia ()
IMPORT_C TPtrC	DatabaseUri ()
IMPORT_C TBool	IsDefault ()
IMPORT_C HPosLmDatabaseInfo *	NewL (const TDesC &)
IMPORT_C HPosLmDatabaseInfo *	NewL (const HPosLmDatabaseInfo &)
IMPORT_C HPosLmDatabaseInfo *	NewLC (const TDesC &)
IMPORT_C HPosLmDatabaseInfo *	NewLC (const HPosLmDatabaseInfo &)
IMPORT_C TPtrC	Protocol ()
void	SetDatabaseDrive ( TChar )
void	SetDefault ( TBool )
void	SetMediaType ( TMediaType )
IMPORT_C const TPosLmDatabaseSettings &	Settings ()
IMPORT_C TPosLmDatabaseSettings &	Settings ()
IMPORT_C TInt	Size ()

Private Member Functions
	HPosLmDatabaseInfo (const TDesC &)
	HPosLmDatabaseInfo (const HPosLmDatabaseInfo &)
TAny *	AllocateL (const TDesC &)
TInt	BufferOffset ()
void	SetDatabaseUri (const TDesC &)
HPosLmDatabaseInfo &	operator= (const HPosLmDatabaseInfo &)

Private Attributes
TUint8	iBuffer
TChar	iDatabaseDrive
TMediaType	iDatabaseMedia
TBool	iIsDefault
TPosLmDatabaseSettings	iSettings

Constructor & Destructor Documentation

HPosLmDatabaseInfo(const TDesC &)

HPosLmDatabaseInfo

(

const TDesC &

aDatabaseUri

)

[private]

Parameters

const TDesC & aDatabaseUri

HPosLmDatabaseInfo(const HPosLmDatabaseInfo &)

HPosLmDatabaseInfo

(

const HPosLmDatabaseInfo &

aDatabaseInfo

)

[private]

Parameters

const HPosLmDatabaseInfo & aDatabaseInfo

Member Functions Documentation

AllocateL(const TDesC &)

TAny *

AllocateL

(

const TDesC &

aDatabaseUri

)

[private, static]

Parameters

const TDesC & aDatabaseUri

BufferOffset()

TInt

BufferOffset

(

)

[private, static]

DatabaseDrive()

IMPORT_C TChar

DatabaseDrive

(

)

const

Returns which database drive the database resides in.

Note: that this attribute is only set if the HPosLmDatabaseInfo instance has been returned from a CPosLmDatabaseManager function, e.g. CPosLmDatabaseManager::ListDatabasesL , CPosLmDatabaseManager::GetDatabaseInfoL , CPosLmDatabaseManager::RegisterDatabaseL , CPosLmDatabaseManager::CreateDatabaseL or CPosLmDatabaseManager::ModifyDatabaseSettingsL . If not, this function returns 0.

If database drive is not applicable for the database, e.g. the database is remote, this function returns 0.

DatabaseMedia()

IMPORT_C TMediaType

DatabaseMedia

(

)

const

Returns which storage media the database resides in.

Note: this attribute is only set if the HPosLmDatabaseInfo instance has been returned from a CPosLmDatabaseManager function, e.g. CPosLmDatabaseManager::ListDatabasesL , CPosLmDatabaseManager::GetDatabaseInfoL , CPosLmDatabaseManager::RegisterDatabaseL , CPosLmDatabaseManager::CreateDatabaseL or CPosLmDatabaseManager::ModifyDatabaseSettingsL . If not, this function returns EMediaUnknown .

DatabaseUri()

IMPORT_C TPtrC

DatabaseUri

(

)

const

Retrieves the database URI.

IsDefault()

IMPORT_C TBool

IsDefault

(

)

const

Returns whether the database is the default database.

NewL(const TDesC &)

IMPORT_C HPosLmDatabaseInfo *

NewL

(

const TDesC &

aDatabaseUri

)

[static]

Two-phased constructor.

Parameters

const TDesC & aDatabaseUri

The URI of the landmark database.

NewL(const HPosLmDatabaseInfo &)

IMPORT_C HPosLmDatabaseInfo *

NewL

(

const HPosLmDatabaseInfo &

aDatabaseInfo

)

[static]

Two-phased copy constructor.

Parameters

const HPosLmDatabaseInfo & aDatabaseInfo

The information instance to copy.

NewLC(const TDesC &)

IMPORT_C HPosLmDatabaseInfo *

NewLC

(

const TDesC &

aDatabaseUri

)

[static]

Two-phased constructor.

Parameters

const TDesC & aDatabaseUri

The URI of the landmark database.

NewLC(const HPosLmDatabaseInfo &)

IMPORT_C HPosLmDatabaseInfo *

NewLC

(

const HPosLmDatabaseInfo &

aDatabaseInfo

)

[static]

Two-phased copy constructor.

Parameters

const HPosLmDatabaseInfo & aDatabaseInfo

The information instance to copy.

Protocol()

IMPORT_C TPtrC

Protocol

(

)

const

Returns the protocol part from the URI which is set.

Example: If the URI is "file://c:landmarks.ldb" then the protocol is "file".

If no protocol is specified, an empty descriptor is returned. This implies "file" protocol.

SetDatabaseDrive(TChar)

void

SetDatabaseDrive

(

TChar

aDatabaseDrive

)

Parameters

TChar aDatabaseDrive

SetDatabaseUri(const TDesC &)

void

SetDatabaseUri

(

const TDesC &

aDatabaseUri

)

[private]

Parameters

const TDesC & aDatabaseUri

SetDefault(TBool)

void

SetDefault

(

TBool

aIsDefault

)

Parameters

TBool aIsDefault

SetMediaType(TMediaType)

void

SetMediaType

(

TMediaType

aMediaType

)

Parameters

TMediaType aMediaType

Settings()

IMPORT_C const TPosLmDatabaseSettings &

Settings

(

)

const

Retrieve a const reference to the database settings.

The const reference can be used to read the database settings.

Settings()

IMPORT_C TPosLmDatabaseSettings &

Settings

(

)

Retrieve a reference to the database settings.

The reference can be used to read and write to the database settings.

Size()

IMPORT_C TInt

Size

(

)

const

Returns the size in bytes of this object.

operator=(const HPosLmDatabaseInfo &)

HPosLmDatabaseInfo &

operator=

(

const HPosLmDatabaseInfo &

)

[private]

Parameters

const HPosLmDatabaseInfo &

Member Data Documentation

TUint8 iBuffer

TUint8

iBuffer

[private]

TChar iDatabaseDrive

TChar

iDatabaseDrive

[private]

TMediaType iDatabaseMedia

TMediaType

iDatabaseMedia

[private]

TBool iIsDefault

TBool

iIsDefault

[private]

TPosLmDatabaseSettings iSettings

TPosLmDatabaseSettings

iSettings

[private]