HPosLmDatabaseInfo Class Reference

class HPosLmDatabaseInfo

HPosLmDatabaseInfo encapsulates information about a landmark database.

eposlmdbmanlib.lib
Since
S60 3.0

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 TCharDatabaseDrive()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 TMediaTypeDatabaseMedia()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 TPtrCDatabaseUri()const

Retrieves the database URI.

IsDefault()

IMPORT_C TBoolIsDefault()const

Returns whether the database is the default database.

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 EFalse.

NewL(const TDesC &)

IMPORT_C HPosLmDatabaseInfo *NewL(const TDesC &aDatabaseUri)[static]

Two-phased constructor.

Parameters

const TDesC & aDatabaseUriThe URI of the landmark database.

NewL(const HPosLmDatabaseInfo &)

IMPORT_C HPosLmDatabaseInfo *NewL(const HPosLmDatabaseInfo &aDatabaseInfo)[static]

Two-phased copy constructor.

Parameters

const HPosLmDatabaseInfo & aDatabaseInfoThe information instance to copy.

NewLC(const TDesC &)

IMPORT_C HPosLmDatabaseInfo *NewLC(const TDesC &aDatabaseUri)[static]

Two-phased constructor.

Parameters

const TDesC & aDatabaseUriThe URI of the landmark database.

NewLC(const HPosLmDatabaseInfo &)

IMPORT_C HPosLmDatabaseInfo *NewLC(const HPosLmDatabaseInfo &aDatabaseInfo)[static]

Two-phased copy constructor.

Parameters

const HPosLmDatabaseInfo & aDatabaseInfoThe information instance to copy.

Protocol()

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

voidSetDatabaseDrive(TCharaDatabaseDrive)

Parameters

TChar aDatabaseDrive

SetDatabaseUri(const TDesC &)

voidSetDatabaseUri(const TDesC &aDatabaseUri)[private]

Parameters

const TDesC & aDatabaseUri

SetDefault(TBool)

voidSetDefault(TBoolaIsDefault)

Parameters

TBool aIsDefault

SetMediaType(TMediaType)

voidSetMediaType(TMediaTypeaMediaType)

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