messagingfw/msgsrvnstore/server/inc/MSVAPI.INL
author Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
Fri, 19 Feb 2010 23:18:09 +0200
branchRCL_3
changeset 6 fe71b07a6401
parent 0 8e480a14352b
permissions -rw-r--r--
Revision: 201003 Kit: 201007

// Copyright (c) 1998-2009 Nokia Corporation and/or its subsidiary(-ies).
// All rights reserved.
// This component and the accompanying materials are made available
// under the terms of "Eclipse Public License v1.0"
// which accompanies this distribution, and is available
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
//
// Initial Contributors:
// Nokia Corporation - initial contribution.
//
// Contributors:
//
// Description:
// CMsvSession
// CMsvEntry
// 
//

inline TMsvId CMsvEntry::EntryId() const
/** Gets the ID of the context.

@return Current context's entry ID */
	{
	return iEntryPtr->Id();
	}

inline const TMsvEntry& CMsvEntry::Entry() const
/** Gets the index entry for the context.

@return Current context's index entry */
	{
	return *iEntryPtr;
	}

inline CMsvSession& CMsvEntry::Session()
/** Gets the Message Server session used by this object. This is the same session 
passed by the client in NewL(). 

@return The session used by the object */
	{
	return iMsvSession;
	}

inline const TMsvSelectionOrdering& CMsvEntry::SortType() const
/** Gets the current sort order of children of the entry. The sort order is initially 
set through NewL().

@return Current sort order */
	{
	return iOrdering;
	}

inline TInt CMsvEntry::Count() const
/** Gets the number of children of the context.

@return Count of the child entries for the current context */
	{
	return iSortedChildren->Count();
	}

inline TMsvId CMsvEntry::OwningService() const
/** Gets the ID of the service entry that owns the context. 

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

@return ID of the service entry that the context is under. */
	{
	return iOwningService;
	}


#if (defined SYMBIAN_MSGS_ENHANCED_REMOVABLE_MEDIA_SUPPORT)

inline TUint CMsvEntry::GetDriveId(TMsvId aMaskedId) const
	{
	TUint driveId = ( (aMaskedId & ~KDriveMask) >> 28);
	if(0 == driveId)
		{
		driveId = KCurrentDriveId;
		}
	return driveId;
	}
#endif
		
//**********************************
// CMsvOperation
//**********************************

inline TMsvOp CMsvOperation::Id() const
/** Gets the operation ID. 

This ID is unique within a Message Server session. The ID allows the client 
to keep track of different operations. 

@return The ID of the operation */
	{
	return iId;
	}

inline TMsvId CMsvOperation::Service() const
/** Gets the ID of the service that is associated with this operation.

If the operation is not associated with a service, the function returns KMsvLocalServiceIndexEntryId.

@return ID of the service associated with the operation */
	{
	return iService;
	}