#include <mw/EPos_HPosLmDatabaseInfo.h>
| class HPosLmDatabaseInfo |
| 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() |
HPosLmDatabaseInfo encapsulates information about a landmark database.
| 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.
Returns: The drive letter for the drive where the database resides, or 0 if the letter is not set.
| 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.
Returns: The storage media the database resides in.
| IMPORT_C TPtrC | DatabaseUri | ( | ) | const |
Retrieves the database URI.
Returns: A pointer to the URI descriptor. This pointer is valid until the HPosLmDatabaseInfo object is destroyed.
| IMPORT_C TBool | IsDefault | ( | ) | 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.
Returns: ETrue if the database is the default one, otherwise EFalse.
| IMPORT_C HPosLmDatabaseInfo * | NewL | ( | const TDesC & | aDatabaseUri | ) | [static] |
Two-phased constructor.
| Parameter | Description |
|---|---|
| aDatabaseUri | The URI of the landmark database. |
Returns: A new instance of this class.
| IMPORT_C HPosLmDatabaseInfo * | NewL | ( | const HPosLmDatabaseInfo & | aDatabaseInfo | ) | [static] |
Two-phased copy constructor.
| Parameter | Description |
|---|---|
| aDatabaseInfo | The information instance to copy. |
Returns: A new instance of this class.
| IMPORT_C HPosLmDatabaseInfo * | NewLC | ( | const TDesC & | aDatabaseUri | ) | [static] |
Two-phased constructor.
| Parameter | Description |
|---|---|
| aDatabaseUri | The URI of the landmark database. |
Returns: A new instance of this class.
| IMPORT_C HPosLmDatabaseInfo * | NewLC | ( | const HPosLmDatabaseInfo & | aDatabaseInfo | ) | [static] |
Two-phased copy constructor.
| Parameter | Description |
|---|---|
| aDatabaseInfo | The information instance to copy. |
Returns: A new instance of this class.
| 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.
Returns: A pointer to the protocol descriptor. This pointer is valid until the HPosLmDatabaseInfo object is destroyed.
| 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.
Returns: Const reference to the database 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.
Returns: Reference to the database settings
| IMPORT_C TInt | Size | ( | ) | const |
Returns the size in bytes of this object.
Returns: The size of this object.