Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: MSVAPI.H
Link against: msgs.lib
Link against: msgs_autoshutdown.lib

Class MessageServer

class MessageServer;

Description

Provides various static information functions relating to the Message Server.

Members

Defined in MessageServer:
CurrentDriveL(), DriveContainsStore(), IsMessageStoreDrivePresentL(), NullUidValue(), Version()

See also:


Member functions


Version()

static IMPORT_C TVersion Version();

Description

Returns the Message Server version number.

Return value

TVersion

Message server version number


NullUidValue()

static IMPORT_C TMsvId NullUidValue();

Description

Returns the predefined message entry ID null value.

Return value

TMsvId

Message entry ID null value


DriveContainsStore()

Capability: AllFiles If not within the message server process
Capability: Illegal

static IMPORT_C TBool DriveContainsStore(RFs &aFs, TInt aDrive);

Description

Checks if the specified drive has a Message Server index on it.

Parameters

RFs &aFs

File server session

TInt aDrive

Drive to check, specified by a TDriveNumber value

Return value

TBool

True if aDrive has a Message Server index, otherwise false

See also:


CurrentDriveL()

Capability: AllFiles If not within the message server process
Capability: Illegal

static IMPORT_C TInt CurrentDriveL(RFs &aFs);

Description

Returns the drive that the Message Server is using to store messages.

Parameters

RFs &aFs

File server session

Return value

TInt

Drive used, specified by a TDriveNumber value

See also:


IsMessageStoreDrivePresentL()

Capability: Illegal

static IMPORT_C TBool IsMessageStoreDrivePresentL(RFs &aFs);

Description

Checks to see if the currently selected drive contains the correct mail store.

If the message store is present on an external drive, we have to check if the same drive is mounted or not before storing the mail.

Parameters

RFs &aFs

Return value

TBool

ETrue if the same drive is mounted. otherwise returns EFalse