MVPbkContactStoreInfo Class Reference

#include <app/MVPbkContactStoreInfo.h>

class MVPbkContactStoreInfo
Public Member Functions
virtual ~MVPbkContactStoreInfo()
virtual TAny *ContactStoreInfoExtension(TUid)
pure virtual TInt64 FreeMemoryL()
pure virtual TInt MaxNumberOfContactsL()
pure virtual TInt MaxNumberOfGroupsL()
pure virtual TInt NumberOfContactsL()
pure virtual TInt NumberOfGroupsL()
pure virtual TInt64 ReservedMemoryL()

Detailed Description

A contact store information interface.

The interface offers access to contact store information that can change runtime.

Constructor & Destructor Documentation

~MVPbkContactStoreInfo ( )

~MVPbkContactStoreInfo()[inline, virtual]

Destructor.

Member Function Documentation

ContactStoreInfoExtension ( TUid )

TAny *ContactStoreInfoExtension(TUid)[inline, virtual]

Returns an extension point for this interface or NULL.

Returns: an extension point for this interface or NULL.

FreeMemoryL ( )

TInt64 FreeMemoryL()const [pure virtual]

Returns the amount of memory in bytes that can be used for the new contacts.

This is practical to implement for stores whose database is in the file system. All store implementations don't know this information and in that case zero is returned.

Returns: Returns the amount of memory (bytes) that can be used for the new contacts or zero if the information is not available

MaxNumberOfContactsL ( )

TInt MaxNumberOfContactsL()const [pure virtual]

Returns the maximum number of contacts that the store can have

Client must always check the return value and compare it to to the KVPbkStoreInfoUnlimitedNumber.

Returns: The maximum number of contacts that the store can have or KVPbkStoreInfoUnlimitedNumber if the store hasn't got a limit.

MaxNumberOfGroupsL ( )

TInt MaxNumberOfGroupsL()const [pure virtual]

Returns the maximum number of groups that the store can have

Returns: The maximum number of groups that the store can have or KVPbkStoreInfoUnlimitedNumber if the store hasn't got a limit. Zero if store doesn't support groups.

NumberOfContactsL ( )

TInt NumberOfContactsL()const [pure virtual]

Returns the current number of contacts in the store

Returns: The current number of contacts in the store

NumberOfGroupsL ( )

TInt NumberOfGroupsL()const [pure virtual]

Returns the current amount of groups in the store.

Returns: The current amount of groups in the store

ReservedMemoryL ( )

TInt64 ReservedMemoryL()const [pure virtual]

Returns the amount of memory in bytes that this store reserves in the media it resides.

This is practical to implement for stores whose database is in the file system. All store implementations don't know their memory consumption and in that case zero is returned.

Returns: The amount of memory (bytes) that this store reserves in the media it resides or zero if the information is not available (e.g in SIM stores)