MessageServer Class Reference

#include <mw/msvapi.h>

Link against: msgs_autoshutdown.lib

class MessageServer
Public Member Enumerations
enumTMsgDcmoSettings { ESmsMms, EEmail }
Public Member Functions
IMPORT_C TIntCurrentDriveL(RFs &)
IMPORT_C TBoolDriveContainsStore(RFs &, TInt)
IMPORT_C TBoolIsMessageStoreDrivePresentL(RFs &)
IMPORT_C TIntMessageSendReceiveAllowed(TMsgDcmoSettings)
IMPORT_C TMsvIdNullUidValue()
IMPORT_C TVersionVersion()

Detailed Description

Provides various static information functions relating to the Message Server.

See also: TDriveNumber

Member Enumeration Documentation

Enum TMsgDcmoSettings

EnumeratorValueDescription
ESmsMms
EEmail

Member Function Documentation

CurrentDriveL ( RFs & )

IMPORT_C TIntCurrentDriveL(RFs &aFs)[static]

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

See also: TDriveNumber

Parameters
aFsFile server session
Return Value
Drive used, specified by a TDriveNumber value
Capability
AllFilesIf not within the message server process
NoneIf within the message server process

DriveContainsStore ( RFs &, TInt )

IMPORT_C TBoolDriveContainsStore(RFs &aFs,
TIntaDrive
)[static]

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

See also: TDriveNumber

Parameters
aFsFile server session
aDriveDrive to check, specified by a TDriveNumber value
Return Value
True if aDrive has a Message Server index, otherwise false
Capability
AllFilesIf not within the message server process
NoneIf within the message server process

IsMessageStoreDrivePresentL ( RFs & )

IMPORT_C TBoolIsMessageStoreDrivePresentL(RFs &aFs)[static]

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.

Return Value
ETrue if the same drive is mounted. otherwise returns EFalse
Capability
None

MessageSendReceiveAllowed ( TMsgDcmoSettings )

IMPORT_C TIntMessageSendReceiveAllowed(TMsgDcmoSettingsaDcmoSettings)[static]

Checks to see if the the sending of sms/mms or email is allowed.

Return Value
on succeed: Cenrep value (0 sending is disallowed / 1 sending is allowed); on fail: 1. KErrArgument if aDcmoSettings parameter is not valid; 2. error code if can not instantiated CRepository or the value can not be read; 3. KErrNotSupported until the email part is not finished;

NullUidValue ( )

IMPORT_C TMsvIdNullUidValue()[static]

Returns the predefined message entry ID null value.

Return Value
Message entry ID null value

Version ( )

IMPORT_C TVersionVersion()[static]

Returns the Message Server version number.

Return Value
Message server version number
© Nokia 2005.