EPOC   SDK Home Glossary Indexes Previous Next Up

TMsvLocalOperationProgress class


Contents


TMsvLocalOperationProgress class — Operation progress

Section Contents


Overview

Compatibility

Applications that use this class will not work correctly on a version of EPOC earlier than ER5.

Derivation

Not applicable

Defined in

msvipc.h

Link against

ment.lib

Description

This class 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.


Constructor


TMsvLocalOperationProgress() — Constructor

TMsvLocalOperationProgress()

Description

The simple constructor initialises the new object to suitable zero or null values.


Public member data

TLocalOperation iType

The type of operation on which the progress is reporting

TInt iTotalNumberOfEntries

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

TInt iNumberCompleted

The number of entries on which the operation has been successful

TInt iNumberFailed

The number of entries on which the operation has failed

TInt iNumberRemaining

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

TInt iError

The error code for the latest failed operation

TMsvId iId

This contains different information for different operation types:

  • copying a single entry: ID of the new entry
  • moving an entry: ID of the entry moved
  • copying or moving multiple entries: ID of the first entry in the selection

Enumerations


TLocalOperation enum

This enumeration defines the possible values for the iType member.

ELocalNone=0

Default value for new TMsvLocalOperationProgress

ELocalMove

Move operation

ELocalDelete

Delete operation

ELocalCopy

Copy operation

ELocalNew

Create operation

ELocalChanged

Change operation

EPOC       SDK Home Glossary Indexes Previous Next Up