McliUtils Class Reference

#include <mw/msvapi.h>

class McliUtils
Public Member Functions
IMPORT_C TMsvLocalOperationProgressGetFinalLocalProgress(CMsvOperation &)
IMPORT_C TMsvLocalOperationProgressGetLocalProgressL(CMsvOperation &)
IMPORT_C TIntGetProgressErrorL(CMsvOperation &)
IMPORT_C TMsvIdGetProgressIdL(CMsvOperation &)

Detailed 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.

Member Function Documentation

GetFinalLocalProgress ( CMsvOperation & )

IMPORT_C TMsvLocalOperationProgressGetFinalLocalProgress(CMsvOperation &aOperation)[static]

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

Parameters
aOperationOperation from which to get progress information
Return Value
Local progress information for aOperation
Panic Codes
MSGS256 aOperation is not a local operation

GetLocalProgressL ( CMsvOperation & )

IMPORT_C TMsvLocalOperationProgressGetLocalProgressL(CMsvOperation &aOperation)[static]

Gets the local progress information from a messaging operation object.

Parameters
aOperationOperation from which to get progress information
Return Value
Local progress information for aOperation
Panic Codes
MSGS256 aOperation is not a local operation

GetProgressErrorL ( CMsvOperation & )

IMPORT_C TIntGetProgressErrorL(CMsvOperation &aOperation)[static]

Gets the progress error from a messaging operation object.

Parameters
aOperationOperation from which to get progress information
Return Value
error of the progress information

GetProgressIdL ( CMsvOperation & )

IMPORT_C TMsvIdGetProgressIdL(CMsvOperation &aOperation)[static]

Gets the progress id from a messaging operation object.

Parameters
aOperationOperation from which to get progress information
Return Value
id of the progress information