Class TMsvLocalOperationProgress

class TMsvLocalOperationProgress;

Description

Encapsulates progress information returned by a local operation. A local operation is a CMsvOperation-derived object returned by a function that affects only local entries. For example, such a function would be a CMsvEntry::ChangeL() call on a local entry. You can check if the operation is local from CMsvOperation::Mtm(): a local operation returns a value of KUidMsvLocalServiceMtm.

Progress information is obtained, in a packaged format, by calling CMsvOperation::ProgressL(). Understanding the TMsvLocalOperationProgress structure enables an application to use that information for a local operation.

Members

Defined in TMsvLocalOperationProgress:
ELocalChanged, ELocalCopy, ELocalDelete, ELocalMove, ELocalNew, ELocalNone, TLocalOperation, TMsvLocalOperationProgress(), iError, iId, iNumberCompleted, iNumberFailed, iNumberRemaining, iTotalNumberOfEntries, iType

IMPORT_C TMsvLocalOperationProgress();

Description

Initialises the new object to suitable zero or null values.

TLocalOperation

Description

Defines the possible values for the type of operation progress report.

ELocalNone Default value for new TMsvLocalOperationProgress ELocalMove Move operation ELocalDelete Delete operation ELocalCopy Copy operation ELocalNew Create operation ELocalChanged Change operation

TLocalOperation iType;

Description

The type of operation on which the progress is reporting

TInt iTotalNumberOfEntries;

Description

The number of entries on which the operation was or will be attempted

TInt iNumberCompleted;

Description

The number of entries on which the operation has been successful

TInt iNumberFailed;

Description

The number of entries on which the operation has failed

TInt iNumberRemaining;

Description

The number of entries on which the operation has yet to be attempted

TInt iError;

Description

The error code for the latest failed operation

TMsvId iId;

Description

This contains different information for different operation types:

1. copying a single entry: ID of the new entry

2. moving an entry: ID of the entry moved

3. copying or moving multiple entries: ID of the first entry in the selection