CMsvEntry Class Reference

#include <mw/msvapi.h>

class CMsvEntry : public CBase, public MMsvSessionObserver, public MMsvStoreObserver, public CBase, public MMsvSessionObserver, public MMsvStoreObserver

Inherits from

CMsvEntry

Public Member Functions
	~CMsvEntry()
IMPORT_C void	AddObserverL(MMsvEntryObserver &)
IMPORT_C void	ChangeAttributesL(const CMsvEntrySelection &, TUint, TUint)
IMPORT_C void	ChangeL(const TMsvEntry &)
IMPORT_C void	ChangeL(const TMsvEntry &, TSecureId)
IMPORT_C CMsvOperation *	ChangeL(const TMsvEntry &, TRequestStatus &)
IMPORT_C CMsvOperation *	ChangeL(const TMsvEntry &, TSecureId, TRequestStatus &)
IMPORT_C CMsvOperation *	ChangeL(const CMsvEntrySelection &, TBool, TRequestStatus &)
IMPORT_C const TMsvEntry &	ChildDataL(TMsvId)
IMPORT_C CMsvEntry *	ChildEntryL(TMsvId)
IMPORT_C CMsvEntrySelection *	ChildrenL()
IMPORT_C CMsvEntrySelection *	ChildrenWithMtmL(TUid)
IMPORT_C CMsvEntrySelection *	ChildrenWithServiceL(TMsvId)
IMPORT_C CMsvEntrySelection *	ChildrenWithTypeL(TUid)
IMPORT_C CMsvOperation *	CopyL(const CMsvEntrySelection &, TMsvId, TRequestStatus &)
IMPORT_C CMsvOperation *	CopyL(TMsvId, TMsvId, TRequestStatus &)
IMPORT_C void	CopyL(const CMsvEntrySelection &, TMsvId, TMsvLocalOperationProgress &)
IMPORT_C void	CopyL(TMsvId, TMsvId)
TInt	Count()
IMPORT_C CMsvOperation *	CreateL(const TMsvEntry &, TRequestStatus &)
IMPORT_C CMsvOperation *	CreateL(const TMsvEntry &, TSecureId, TRequestStatus &)
IMPORT_C void	CreateL(TMsvEntry &)
IMPORT_C void	CreateL(TMsvEntry &, TSecureId)
IMPORT_C CMsvOperation *	DeleteL(const CMsvEntrySelection &, TRequestStatus &)
IMPORT_C CMsvOperation *	DeleteL(TMsvId, TRequestStatus &)
IMPORT_C void	DeleteL(TMsvId)
IMPORT_C void	DeleteL(const CMsvEntrySelection &, TMsvLocalOperationProgress &)
IMPORT_C CMsvStore *	EditStoreL()
const TMsvEntry &	Entry()
TMsvId	EntryId()
virtual void	HandleSessionEventL(TMsvSessionEvent, TAny , TAny , TAny *)
virtual void	HandleStoreEvent(TMsvStoreEvent, TMsvId)
IMPORT_C TBool	HasStoreL()
IMPORT_C CMsvOperation *	MoveL(const CMsvEntrySelection &, TMsvId, TRequestStatus &)
IMPORT_C CMsvOperation *	MoveL(TMsvId, TMsvId, TRequestStatus &)
IMPORT_C void	MoveL(TMsvId, TMsvId)
IMPORT_C void	MoveL(const CMsvEntrySelection &, TMsvId, TMsvLocalOperationProgress &)
IMPORT_C CMsvEntry *	NewL(CMsvSession &, TMsvId, const TMsvSelectionOrdering &)
TMsvId	OwningService()
IMPORT_C CMsvStore *	ReadStoreL()
IMPORT_C void	RemoveObserver(MMsvEntryObserver &)
CMsvSession &	Session()
IMPORT_C void	SetEntryL(TMsvId)
IMPORT_C void	SetEntryNoCheckL(TMsvId)
IMPORT_C void	SetMtmListL(const CArrayFix< TUid > &)
IMPORT_C void	SetSortTypeL(const TMsvSelectionOrdering &)
const TMsvSelectionOrdering &	SortType()
IMPORT_C const TMsvEntry &	operator[](TInt)

Inherited Enumerations
	MMsvSessionObserver:TMsvSessionEvent
	MMsvStoreObserver:TMsvStoreEvent

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Detailed Description

Accesses and acts upon a particular Message Server entry. The current entry that a CMsvEntry object relates is referred to as its context.

It may be helpful to consider CMsvEntry functions in two broad groups. The first provides means to access the various types of storage associated with an entry. The second provides a means to discover and access other entries that the entry owns (its children).

Message client applications, Client-side MTMs, and User Interface MTMs all commonly use CMsvEntry objects. CMsvEntry objects though represent a lower level of access to an entry than that provided by a Client-side MTM or User Interface MTM. In particular, any MTM-specific functionality, such as address lists or subject fields, must be accessed by a message client application through an MTM inteface.

A CMsvEntry object is relatively expensive in RAM usage, as it caches its children, updating them as necessary when notified of changes. They should therefore be created sparingly.

Note that Server-side MTMs do not use this class, but a similar one, CMsvServerEntry.

Constructor & Destructor Documentation

~CMsvEntry ( )

IMPORT_C

~CMsvEntry

(

)

Destructor.

This cleans up the object. CMsvEntry objects must be deleted by client applications when they are no longer required. Note that deleting a CMsvEntry object does not delete the context, simply the immediate means of accessing it.

Member Function Documentation

AddObserverL ( MMsvEntryObserver & )

IMPORT_C void

AddObserverL

(

MMsvEntryObserver &

aObserver

)

Registers an observer for the object.

CMsvEntry objects can call back observer objects that implement the MMsvEntryObserver interface when certain events occur. Any number of observers can be registered.

Observers are called primarily when the context changes state or contents. For details, see MMsvEntryObserver::TMsvEntryEvent.

Parameters
aObserver	The observer to be registered for events

Leave Codes
KErrNoMemory	Not enough memory to register the observer

ChangeAttributesL ( const CMsvEntrySelection &, TUint, TUint )

IMPORT_C void	ChangeAttributesL	(	const CMsvEntrySelection &	aSelection,
			TUint	aSetAttributes,
			TUint	aClearAttributes
		)

Sets or clears multiple fields in a selection of children of the context.

Fields to change are specified using a bitmask of TMsvAttribute values. Possible fields that can be changed using this function are the PC synchronisation, Visibility, Pending Deletion, Read, In-preparation, Connected, and New flags.

Parameters
aSelection	The entries to change
aSetAttributes	A bitmask of the fields to set
aClearAttributes	A bitmask of the fields to clear

Leave Codes
KErrNotFound	An entry was not a child of the context

ChangeL ( const TMsvEntry & )

IMPORT_C void

ChangeL

(

const TMsvEntry &

aEntry

)

Sets the context's index entry to the specified values. The function is performed synchronously.

This function can only be used on local entries.

Parameters
aEntry	The new index entry values for the context

Leave Codes
KErrAccessDenied	The entry is locked by another client
KErrArgument	aEntry is invalid or the ID specified in aEntry is not the same as the context ID
KErrNoMemory	The operation could not be created or passed to the server

ChangeL ( const TMsvEntry &, TSecureId )

IMPORT_C void	ChangeL	(	const TMsvEntry &	aEntry,
			TSecureId	aOwnerId
		)

Sets the context's index entry to the specified values. The function is performed synchronously. Sets the owner of the changed entry to process specified by the supplied ID.

This function can only be used on local entries.

Parameters
aEntry	The new index entry values for the context
aOwnerId	The ID of process that owns the changed entry.

Leave Codes
KErrAccessDenied	The entry is locked by another client
KErrArgument	aEntry is invalid or the ID specified in aEntry is not the same as the context ID
KErrNoMemory	The operation could not be created or passed to the server

ChangeL ( const TMsvEntry &, TRequestStatus & )

IMPORT_C CMsvOperation *	ChangeL	(	const TMsvEntry &	aEntry,
			TRequestStatus &	aStatus
		)

Sets the context's index entry to the specified values. The returned CMsvOperation object completes when the change is complete.

It is important to note that the state of the context is undefined until the observer of the entry has been informed that the entry has been changed, or the operation is completed with an error. If the function leaves, the context is unchanged.

Parameters
aEntry	The new index entry values for the context
aStatus	The request status to be completed when the operation has finished

Return Value: An operation object controlling the change command

Leave Codes
KErrAccessDenied	The entry is locked by another client
KErrArgument	aEntry is invalid or the ID specified in aEntry is not the same as the context ID
KErrNoMemory	The operation could not be created or passed to the server

ChangeL ( const TMsvEntry &, TSecureId, TRequestStatus & )

IMPORT_C CMsvOperation *	ChangeL	(	const TMsvEntry &	aEntry,
			TSecureId	aOwnerId,
			TRequestStatus &	aStatus
		)

Sets the context's index entry to the specified values. The returned CMsvOperation object completes when the change is complete. Sets the owner of the changed entry to process specified by the supplied ID.

Parameters
aEntry	The new index entry values for the context
aOwnerId	The ID of process that owns the changed entry.
aStatus	The request status to be completed when the operation has finished

Return Value: An operation object controlling the change command

Leave Codes
KErrAccessDenied	The entry is locked by another client
KErrArgument	aEntry is invalid or the ID specified in aEntry is not the same as the context ID
KErrNoMemory	The operation could not be created or passed to the server

ChangeL ( const CMsvEntrySelection &, TBool, TRequestStatus & )

IMPORT_C CMsvOperation *	ChangeL	(	const CMsvEntrySelection &	aSelection,
			TBool	aMark,
			TRequestStatus &	aStatus
		)

Update a selection of children to read or Unread asynchronously of the context. The returned CMsvOperation object .

Parameters
aSelection	The selectio of entry values for the context
aMark	True : Update selection to UnRead . False: Update selection to Read .
aStatus	The request status to be completed when the operation has finished .

Return Value: An operation object controlling the change command

Leave Codes
KErrAccessDenied	The entry is locked by another client

ChildDataL ( TMsvId )

IMPORT_C const TMsvEntry &

ChildDataL

(

TMsvId

aId

)

const

Gets the index entry of context's child with the specified ID.

Parameters
aId	ID of the child

Return Value: Index entry for the specified child. Valid for in-range values of aIndex.

Leave Codes
KErrNotFound	No child exists with that ID

ChildEntryL ( TMsvId )

IMPORT_C CMsvEntry *

ChildEntryL

(

TMsvId

aId

)

const

Gets a new CMsvEntry object with its context set to the child entry ID. aMsvId must specify a child of the current context.

The CMsvEntry object must be deleted by the client application when it is no longer required.

Parameters
aId	ID of a child entry

Return Value: CMsvEntry object with its context set to child entry

Leave Codes
KErrNotFound	aMsvId does not specify a child of the context

ChildrenL ( )

IMPORT_C CMsvEntrySelection *

ChildrenL

(

)

const

Gets a selection containing the IDs of all the context children. If the entry has no children, the selection is empty.

The calling function is responsible for the deletion of the returned CMsvEntrySelection.

Return Value: A selection containing the ID of all children of the context

Leave Codes
KErrNoMemory	Not enough memory to create the selection

ChildrenWithMtmL ( TUid )

IMPORT_C CMsvEntrySelection *

ChildrenWithMtmL

(

TUid

aMtm

)

const

Gets a selection containing the IDs of all the context children filtered by MTM type. i.e. the index entry's iMtm field equals aMtm.

If the entry has no such children, the selection is empty.

The calling function is responsible for the deletion of the returned CMsvEntrySelection.

Parameters
aMtm	MTM type by which to filter

Return Value: A selection containing the ID of all children of the context meeting the criterion

Leave Codes
KErrNoMemory	Not enough memory to create the selection

ChildrenWithServiceL ( TMsvId )

IMPORT_C CMsvEntrySelection *

ChildrenWithServiceL

(

TMsvId

aServiceId

)

const

Gets a selection containing the IDs of all the context children filtered by message service. i.e. the index entry's iServiceId field equals aId.

If the entry has no such children, the selection is empty.

The calling function is responsible for the deletion of the returned CMsvEntrySelection.

Parameters
aServiceId	Service by which to filter

Return Value: List of IDs of all children of the context meeting the criterion

Leave Codes
KErrNoMemory	Not enough memory to create the selection

ChildrenWithTypeL ( TUid )

IMPORT_C CMsvEntrySelection *

ChildrenWithTypeL

(

TUid

aType

)

const

Gets a selection containing the IDs of all the context children filtered by entry type. i.e. is the entry a folder, a message, etc.

If the entry has no such children, the selection is empty.

The calling function is responsible for the deletion of the returned CMsvEntrySelection.

Parameters
aType	Entry type by which to filter.

Return Value: A selection containing the ID of all children of the context meeting the criterion

Leave Codes
KErrNoMemory	Not enough memory to create the selection

CopyL ( const CMsvEntrySelection &, TMsvId, TRequestStatus & )

IMPORT_C CMsvOperation *	CopyL	(	const CMsvEntrySelection &	aSelection,
			TMsvId	aTargetId,
			TRequestStatus &	aStatus
		)

Creates, asynchronously. copies of children of the context as new entries owned by the specified target ID.

All descendants will be copied as well. Any files and stores associated with the entries are also copied.

The returned CMsvOperation object completes when copying is complete.

Parameters
aSelection	List of IDs of the entries to be copied
aTargetId	The ID of the entry to own the copies
aStatus	The request status to be completed when the operation has finished

Return Value: The operation object controlling the copy command.

Leave Codes
KErrNoMemory	The operation could not be created or passed to the server
KErrNotFound	An entry was not a child of the context

CopyL ( TMsvId, TMsvId, TRequestStatus & )

IMPORT_C CMsvOperation *	CopyL	(	TMsvId	aMsvId,
			TMsvId	aTargetId,
			TRequestStatus &	aStatus
		)

Creates, asynchronously, a copy of a child of the context as a new entry owned by the specified target ID.

All descendants will be copied as well. Any files and stores associated with the entry are also copied.

The returned CMsvOperation object completes when copying is complete.

Parameters
aMsvId	The ID of the entry to be copied
aTargetId	The ID of the entry to own the copy
aStatus	The request status to be completed when the operation has finished

Return Value: The operation object controlling the copy command.

Leave Codes
KErrNoMemory	The operation could not be created or passed to the server
KErrNotFound	An entry was not a child of the context

CopyL ( const CMsvEntrySelection &, TMsvId, TMsvLocalOperationProgress & )

IMPORT_C void	CopyL	(	const CMsvEntrySelection &	aSelection,
			TMsvId	aTargetId,
			TMsvLocalOperationProgress &	aProgress
		)

Creates, synchronously. copies of children of the context as new entries owned by the specified target ID.

All descendants will be copied as well. Any files and stores associated with the entries are also copied.

Parameters
aSelection	List of IDs of the entries to be copied
aTargetId	The ID of the entry to own the copies
aProgress	On return, records the outcome of the copy

Leave Codes
KErrNoMemory
KErrNotFound	An entry was not a child of the context

CopyL ( TMsvId, TMsvId )

IMPORT_C void	CopyL	(	TMsvId	aMsvId,
			TMsvId	aTargetId
		)

Creates, synchronously, a copy of a child of the context as a new entry owned by the specified target ID.

Parameters
aMsvId	The ID of the entry to be copied
aTargetId	The ID of the entry to own the copy

Count ( )

TInt

Count

(

)

const [inline]

Gets the number of children of the context.

Return Value: Count of the child entries for the current context

CreateL ( const TMsvEntry &, TRequestStatus & )

IMPORT_C CMsvOperation *	CreateL	(	const TMsvEntry &	aEntry,
			TRequestStatus &	aStatus
		)

Creates a new child entry owned by the context asynchronously.

Note that all session observers are notified when a new entry is created with an EMsvEntriesCreated event (see TMsvSessionEvent). CMsvEntry objects are such session observers themselves. When the object receives such a session notification, it calls all registered entry observers with a TMsvEntryEvent event EMsvNewChildren, passing in the ID of the new child.

If aEntry is not a service entry, then the context must not be set to the root entry and iServiceId field must be defined . If aEntry is a service entry, then the context must be set to the root entry.

The returned CMsvOperation object completes when creation is complete.

Parameters
aEntry	Index entry value for the new entry
aStatus	The request status to be completed when the operation has finished

Return Value: The operation object controlling the create command.

Leave Codes
KErrArgument	aEntry is invalid

CreateL ( const TMsvEntry &, TSecureId, TRequestStatus & )

IMPORT_C CMsvOperation *	CreateL	(	const TMsvEntry &	aEntry,
			TSecureId	aOwnerId,
			TRequestStatus &	aStatus
		)

Creates a new child entry owned by the context asynchronously. Sets the owner of the created entry to process specified by the supplied ID.

The returned CMsvOperation object completes when creation is complete.

Parameters
aEntry	Index entry value for the new entry
aOwnerId	The ID of process that owns the created entry.
aStatus	The request status to be completed when the operation has finished

Return Value: The operation object controlling the create command.

Leave Codes
KErrArgument	aEntry is invalid

CreateL ( TMsvEntry & )

IMPORT_C void

CreateL

(

TMsvEntry &

aEntry

)

Creates a new child entry owned by the context synchronously.

This function can only be used on local entries.

Parameters
aEntry	Index entry value for the new entry

Leave Codes
KErrArgument	aEntry is invalid

CreateL ( TMsvEntry &, TSecureId )

IMPORT_C void	CreateL	(	TMsvEntry &	aEntry,
			TSecureId	aOwnerId
		)

Creates a new child entry owned by the context synchronously. Sets the owner of the created entry to process specified by the supplied ID.

This function can only be used on local entries.

Parameters
aEntry	Index entry value for the new entry
aOwnerId	The ID of process that owns the created entry.

Leave Codes
KErrArgument	aEntry is invalid

DeleteL ( const CMsvEntrySelection &, TRequestStatus & )

IMPORT_C CMsvOperation *	DeleteL	(	const CMsvEntrySelection &	aSelection,
			TRequestStatus &	aStatus
		)

Deletes child entries of the context asynchronously.

The delete works recursively through all the descendants. If a child or any descendant is locked by another client or any store or file is open, then that child will not be deleted. Any files and stores associated with the entries are deleted.

The returned CMsvOperation object completes when deletion is complete.

Parameters
aSelection	List of ID of the entries to be deleted
aStatus	The request status to be completed when the operation has finished

Return Value: The operation object controlling the deletion command

Leave Codes
KErrNotFound	A specified entry was not a child of the context
KErrNotSupported	If deleting entries from non-current drive

DeleteL ( TMsvId, TRequestStatus & )

IMPORT_C CMsvOperation *	DeleteL	(	TMsvId	aMsvId,
			TRequestStatus &	aStatus
		)

Deletes a child entry of the context asynchronously.

The returned CMsvOperation object completes when deletion is complete.

Parameters
aMsvId	ID of entry to be deleted
aStatus	The request status to be completed when the operation has finished

Return Value: The operation object controlling the deletion command

Leave Codes
KErrNotFound	The specified entry was not a child of the context
KErrNotSupported	If deleting entries from non-current drive

DeleteL ( TMsvId )

IMPORT_C void

DeleteL

(

TMsvId

aId

)

Deletes a child entry of the context synchronously.

This function can only be used on local entries.

Parameters
aId	ID of entry to be deleted

Leave Codes
KErrNotFound	The specified entry was not a child of the context
KErrNotSupported	If deleting entries from non-current drive

DeleteL ( const CMsvEntrySelection &, TMsvLocalOperationProgress & )

IMPORT_C void	DeleteL	(	const CMsvEntrySelection &	aSelection,
			TMsvLocalOperationProgress &	aProgress
		)

Deletes child entries of the context synchronously.

Parameters
aSelection	List of ID of the entries to be deleted
aProgress	Progress information for the delete operation

Leave Codes
KErrNotFound	A specified entry was not a child of the context
KErrNotSupported	If deleting entries from non-current drive

EditStoreL ( )

IMPORT_C CMsvStore *

EditStoreL

(

)

Gets the message store for the current context with read-write access.

Only one client can edit a message store at one time. If another client is already writing to the store, KErrAccessDenied is returned. Other clients can be reading the store.

If the message store does not exist when EditStore() is called, a new message store is created.

The returned CMsvStore must be deleted when it is no longer required.

Return Value: Context's message store open for read-write access

Leave Codes
KErrAccessDenied	Store is locked by another process or the entry is read only
KErrNoMemory	Not enough memory to open the store

Entry ( )

const TMsvEntry &

Entry

(

)

const [inline]

Gets the index entry for the context.

Return Value: Current context's index entry

EntryId ( )

TMsvId

EntryId

(

)

const [inline]

Gets the ID of the context.

Return Value: Current context's entry ID

HandleSessionEventL ( TMsvSessionEvent, TAny , TAny , TAny * )

void	HandleSessionEventL	(	TMsvSessionEvent	aEvent,
			TAny *	aArg1,
			TAny *	aArg2,
			TAny *	aArg3
		)	[virtual]

Reimplemented from MMsvSessionObserver::HandleSessionEventL(TMsvSessionEvent,TAny *,TAny *,TAny *)

Indicates an event has occurred.

The type of event is indicated by the value of aEvent. The interpretation of the TAny arguments depends on this type.

For most event types, the action that is taken, for example, updating the display, is client-specific. All clients though should respond to EMsvCloseSession and EMsvServerTerminated events.

Parameters
aEvent	Indicates the event type.
aArg1	Event type-specific argument value
aArg2	Event type-specific argument value
aArg3	Event type-specific argument value

HandleStoreEvent ( TMsvStoreEvent, TMsvId )

void	HandleStoreEvent	(	TMsvStoreEvent	aEvent,
			TMsvId	aId
		)	[virtual]

Reimplemented from MMsvStoreObserver::HandleStoreEvent(TMsvStoreEvent,TMsvId)

Receives a message store event.

Parameters
aEvent	Event type
aId	ID of the message to which the event relates

HasStoreL ( )

IMPORT_C TBool

HasStoreL

(

)

const

Checks if the context has an associated message store.

Return Value: ETrue: entry has a message store EFalse: entry does not have a message store

MoveL ( const CMsvEntrySelection &, TMsvId, TRequestStatus & )

IMPORT_C CMsvOperation *	MoveL	(	const CMsvEntrySelection &	aSelection,
			TMsvId	aTargetId,
			TRequestStatus &	aStatus
		)

Moves, asynchronously, children of the context to become entries owned by the target entry.

All descendants will be moved as well. Any files and stores associated with the entries are also moved.

The returned CMsvOperation object completes when moving is complete.

Parameters
aSelection	List of IDs of the entries to be moved
aTargetId	The ID of the entry to own the moved entires
aStatus	The request status to be completed when the operation has finished

Return Value: The operation object controlling the move command.

Leave Codes
KErrNoMemory	The operation could not be created or passed to the server
KErrNotFound	An entry was not a child of the context

MoveL ( TMsvId, TMsvId, TRequestStatus & )

IMPORT_C CMsvOperation *	MoveL	(	TMsvId	aMsvId,
			TMsvId	aTargetId,
			TRequestStatus &	aStatus
		)

Moves, asynchronously, a child of the context to become an entry owned by the target entry.

All descendants will be moved as well. Any files and stores associated with the entry are also moved.

The returned CMsvOperation object completes when moving is complete.

Parameters
aMsvId	The ID of the entry to be moved
aTargetId	The ID of the entry to own the moved entries
aStatus	The request status to be completed when the operation has finished

Return Value: The operation object controlling the move command.

Leave Codes
KErrNoMemory	The operation could not be created or passed to the server
KErrNotFound	An entry was not a child of the context

MoveL ( TMsvId, TMsvId )

IMPORT_C void	MoveL	(	TMsvId	aMsvId,
			TMsvId	aTargetId
		)

Moves, synchronously, a child of the context to become an entry owned by the target entry.

All descendants will be moved as well. Any files and stores associated with the entry are also moved.

Parameters
aMsvId	The ID of the entry to be moved
aTargetId	The ID of the entry to own the moved entries

Leave Codes
KErrNoMemory
KErrNotFound	An entry was not a child of the context

MoveL ( const CMsvEntrySelection &, TMsvId, TMsvLocalOperationProgress & )

IMPORT_C void	MoveL	(	const CMsvEntrySelection &	aSelection,
			TMsvId	aTargetId,
			TMsvLocalOperationProgress &	aProgress
		)

Moves, synchronously, children of the context to become entries owned by the target entry.

All descendants will be moved as well. Any files and stores associated with the entries are also moved.

Parameters
aSelection	List of IDs of the entries to be moved
aTargetId	The ID of the entry to own the moved entires
aProgress	On return, records the outcome of the move

Leave Codes
KErrNoMemory
KErrNotFound	An entry was not a child of the context

NewL ( CMsvSession &, TMsvId, const TMsvSelectionOrdering & )

IMPORT_C CMsvEntry *	NewL	(	CMsvSession &	aMsvSession,
			TMsvId	aMsvId,
			const TMsvSelectionOrdering &	aOrdering
		)	[static]

Creates a new CMsvEntry for the specified entry ID.

Note that this function does not create a new entry, but simply a new object to access an existing entry. To create a new entry, use CreateL().

Parameters
aMsvSession	The clients Message Server session
aMsvId	ID of the entry to access

Return Value: If the function succeeds, this is a pointer to a newly allocated and initialised object.

Leave Codes
KErrNotFound	The requested entry does not exist
KErrNoMemory	A memory allocation failed

OwningService ( )

TMsvId

OwningService

(

)

const [inline]

Gets the ID of the service entry that owns the context.

Local entries are considered as being members of the local service:

Return Value: ID of the service entry that the context is under.

ReadStoreL ( )

IMPORT_C CMsvStore *

ReadStoreL

(

)

Obtains the message store for the current context with read-only access.

Multiple clients can read from a store simultaneously. If another client is already writing to the store, the function leaves with KErrAccessDenied.

The returned CMsvStore must be deleted when it is no longer required.

Return Value: Context's message store open for read-only access

Leave Codes
KErrNoMemory	Not enough memory to open store
KErrAccessDenied	Another client is currently writing to the store
KErrNotFound	There is no store associated with this entry

RemoveObserver ( MMsvEntryObserver & )

IMPORT_C void

RemoveObserver

(

MMsvEntryObserver &

aObserver

)

Unregisters an observer previously registered with AddObserverL().

Parameters
aObserver	A reference to an observer to be unregistered for events

Session ( )

CMsvSession &

Session

(

)

[inline]

Gets the Message Server session used by this object. This is the same session passed by the client in NewL().

Return Value: The session used by the object

SetEntryL ( TMsvId )

IMPORT_C void

SetEntryL

(

TMsvId

aId

)

Sets the context to the specified entry.

If the function leaves, the context is unchanged.

Parameters
aId	ID of the message entry which is to become the new context

Leave Codes
KErrNotFound	aId could not be found in the index

SetEntryNoCheckL ( TMsvId )

IMPORT_C void

SetEntryNoCheckL

(

TMsvId

aId

)

Sets the context to the specified entry.

If the function leaves, the context is unchanged.

Parameters
aId	ID of the message entry which is to become the new context

Leave Codes
KErrNotFound	aMsvId could not be found in the index

SetMtmListL ( const CArrayFix< TUid > & )

IMPORT_C void

SetMtmListL

(

const CArrayFix< TUid > &

aMtmList

)

Sets the MTM order to the specified sort order. When children of an entry are sorted, entries belonging to the same MTM type can be grouped together.

MTM grouping can be switched on or off through setting the appropriate TMsvSelectionOrdering value by SetSortTypeL().

If the function leaves, the sort order is unchanged.

Parameters
aMtmList	The order of MTMs to use for sorting

Leave Codes
KErrNoMemory	Insufficient memory to resort the entries

SetSortTypeL ( const TMsvSelectionOrdering & )

IMPORT_C void

SetSortTypeL

(

const TMsvSelectionOrdering &

aOrdering

)

Sets the sort order that is used when listing children, for example with ChildrenL().

If the function leaves, the sort order is unchanged.

Parameters
aOrdering	Sort order to use

Leave Codes
KErrNoMemory	Insufficient memory to resort the entries

SortType ( )

const TMsvSelectionOrdering &

SortType

(

)

const [inline]

Gets the current sort order of children of the entry. The sort order is initially set through NewL().

Return Value: Current sort order

operator[] ( TInt )

IMPORT_C const TMsvEntry &

operator[]

(

TInt

aIndex

)

const

Gets the index entry of the child at the position specified by the array index. The child entries of the context can be considered as a zero-based array, with entries sorted according to the current sort order.

Note:

The function panics with E32USER-CBase 21 if aIndex was out of range.

Parameters
aIndex	Array index

Return Value: Index entry for the specified child. Valid for in-range values of aIndex.

CMsvEntry Class Reference

Inherits from

Detailed Description

Constructor & Destructor Documentation

~CMsvEntry ( )

Member Function Documentation

AddObserverL ( MMsvEntryObserver & )

ChangeAttributesL ( const CMsvEntrySelection &, TUint, TUint )

ChangeL ( const TMsvEntry & )

ChangeL ( const TMsvEntry &, TSecureId )

ChangeL ( const TMsvEntry &, TRequestStatus & )

ChangeL ( const TMsvEntry &, TSecureId, TRequestStatus & )

ChangeL ( const CMsvEntrySelection &, TBool, TRequestStatus & )

ChildDataL ( TMsvId )

ChildEntryL ( TMsvId )

ChildrenL ( )

ChildrenWithMtmL ( TUid )

ChildrenWithServiceL ( TMsvId )

ChildrenWithTypeL ( TUid )

CopyL ( const CMsvEntrySelection &, TMsvId, TRequestStatus & )

CopyL ( TMsvId, TMsvId, TRequestStatus & )

CopyL ( const CMsvEntrySelection &, TMsvId, TMsvLocalOperationProgress & )

CopyL ( TMsvId, TMsvId )

Count ( )

CreateL ( const TMsvEntry &, TRequestStatus & )

CreateL ( const TMsvEntry &, TSecureId, TRequestStatus & )

CreateL ( TMsvEntry & )

CreateL ( TMsvEntry &, TSecureId )

DeleteL ( const CMsvEntrySelection &, TRequestStatus & )

DeleteL ( TMsvId, TRequestStatus & )

DeleteL ( TMsvId )

DeleteL ( const CMsvEntrySelection &, TMsvLocalOperationProgress & )

EditStoreL ( )

Entry ( )

EntryId ( )

HandleSessionEventL ( TMsvSessionEvent, TAny *, TAny *, TAny * )

HandleStoreEvent ( TMsvStoreEvent, TMsvId )

HasStoreL ( )

MoveL ( const CMsvEntrySelection &, TMsvId, TRequestStatus & )

MoveL ( TMsvId, TMsvId, TRequestStatus & )

MoveL ( TMsvId, TMsvId )

MoveL ( const CMsvEntrySelection &, TMsvId, TMsvLocalOperationProgress & )

NewL ( CMsvSession &, TMsvId, const TMsvSelectionOrdering & )

OwningService ( )

ReadStoreL ( )

RemoveObserver ( MMsvEntryObserver & )

Session ( )

SetEntryL ( TMsvId )

SetEntryNoCheckL ( TMsvId )

SetMtmListL ( const CArrayFix< TUid > & )

SetSortTypeL ( const TMsvSelectionOrdering & )

SortType ( )

operator[] ( TInt )

HandleSessionEventL ( TMsvSessionEvent, TAny , TAny , TAny * )