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 McliUtils

class McliUtils;

Description

Utility class to simplify getting progress information from a messaging operation object.

The functions get and unpack the progress information buffers from an operation object.

Members

Defined in McliUtils:
GetFinalLocalProgress(), GetLocalProgressL(), GetProgressErrorL(), GetProgressIdL()


Member functions


GetLocalProgressL()

static IMPORT_C TMsvLocalOperationProgress GetLocalProgressL(CMsvOperation &aOperation);

Description

Gets the local progress information from a messaging operation object.

Parameters

CMsvOperation &aOperation

Operation from which to get progress information

Return value

TMsvLocalOperationProgress

Local progress information for aOperation

Panic codes

MSGS

256 aOperation is not a local operation


GetFinalLocalProgress()

static IMPORT_C TMsvLocalOperationProgress GetFinalLocalProgress(CMsvOperation &aOperation);

Description

Gets the final local progress information from a messaging operation object.

Parameters

CMsvOperation &aOperation

Operation from which to get progress information

Return value

TMsvLocalOperationProgress

Local progress information for aOperation

Panic codes

MSGS

256 aOperation is not a local operation


GetProgressErrorL()

static IMPORT_C TInt GetProgressErrorL(CMsvOperation &aOperation);

Description

Gets the progress error from a messaging operation object.

Parameters

CMsvOperation &aOperation

Operation from which to get progress information

Return value

TInt

error of the progress information


GetProgressIdL()

static IMPORT_C TMsvId GetProgressIdL(CMsvOperation &aOperation);

Description

Gets the progress id from a messaging operation object.

Parameters

CMsvOperation &aOperation

Operation from which to get progress information

Return value

TMsvId

id of the progress information