messagingfw/msgsrvnstore/server/inc/MSVAPI.INL
changeset 0 8e480a14352b
equal deleted inserted replaced
-1:000000000000 0:8e480a14352b
       
     1 // Copyright (c) 1998-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     2 // All rights reserved.
       
     3 // This component and the accompanying materials are made available
       
     4 // under the terms of "Eclipse Public License v1.0"
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 // CMsvSession
       
    15 // CMsvEntry
       
    16 // 
       
    17 //
       
    18 
       
    19 inline TMsvId CMsvEntry::EntryId() const
       
    20 /** Gets the ID of the context.
       
    21 
       
    22 @return Current context's entry ID */
       
    23 	{
       
    24 	return iEntryPtr->Id();
       
    25 	}
       
    26 
       
    27 inline const TMsvEntry& CMsvEntry::Entry() const
       
    28 /** Gets the index entry for the context.
       
    29 
       
    30 @return Current context's index entry */
       
    31 	{
       
    32 	return *iEntryPtr;
       
    33 	}
       
    34 
       
    35 inline CMsvSession& CMsvEntry::Session()
       
    36 /** Gets the Message Server session used by this object. This is the same session 
       
    37 passed by the client in NewL(). 
       
    38 
       
    39 @return The session used by the object */
       
    40 	{
       
    41 	return iMsvSession;
       
    42 	}
       
    43 
       
    44 inline const TMsvSelectionOrdering& CMsvEntry::SortType() const
       
    45 /** Gets the current sort order of children of the entry. The sort order is initially 
       
    46 set through NewL().
       
    47 
       
    48 @return Current sort order */
       
    49 	{
       
    50 	return iOrdering;
       
    51 	}
       
    52 
       
    53 inline TInt CMsvEntry::Count() const
       
    54 /** Gets the number of children of the context.
       
    55 
       
    56 @return Count of the child entries for the current context */
       
    57 	{
       
    58 	return iSortedChildren->Count();
       
    59 	}
       
    60 
       
    61 inline TMsvId CMsvEntry::OwningService() const
       
    62 /** Gets the ID of the service entry that owns the context. 
       
    63 
       
    64 Local entries are considered as being members of the local service: 
       
    65 
       
    66 @return ID of the service entry that the context is under. */
       
    67 	{
       
    68 	return iOwningService;
       
    69 	}
       
    70 
       
    71 
       
    72 #if (defined SYMBIAN_MSGS_ENHANCED_REMOVABLE_MEDIA_SUPPORT)
       
    73 
       
    74 inline TUint CMsvEntry::GetDriveId(TMsvId aMaskedId) const
       
    75 	{
       
    76 	TUint driveId = ( (aMaskedId & ~KDriveMask) >> 28);
       
    77 	if(0 == driveId)
       
    78 		{
       
    79 		driveId = KCurrentDriveId;
       
    80 		}
       
    81 	return driveId;
       
    82 	}
       
    83 #endif
       
    84 		
       
    85 //**********************************
       
    86 // CMsvOperation
       
    87 //**********************************
       
    88 
       
    89 inline TMsvOp CMsvOperation::Id() const
       
    90 /** Gets the operation ID. 
       
    91 
       
    92 This ID is unique within a Message Server session. The ID allows the client 
       
    93 to keep track of different operations. 
       
    94 
       
    95 @return The ID of the operation */
       
    96 	{
       
    97 	return iId;
       
    98 	}
       
    99 
       
   100 inline TMsvId CMsvOperation::Service() const
       
   101 /** Gets the ID of the service that is associated with this operation.
       
   102 
       
   103 If the operation is not associated with a service, the function returns KMsvLocalServiceIndexEntryId.
       
   104 
       
   105 @return ID of the service associated with the operation */
       
   106 	{
       
   107 	return iService;
       
   108 	}