epoc32/include/msvapi.inl
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:27:01 +0100
branchSymbian2
changeset 3 e1b950c65cb4
parent 0 061f57f2323e
permissions -rw-r--r--
Attempt to represent the S^2->S^3 header reorganisation as a series of "hg rename" operations
     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 the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.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 //**********************************
    73 // CMsvOperation
    74 //**********************************
    75 
    76 inline TMsvOp CMsvOperation::Id() const
    77 /** Gets the operation ID. 
    78 
    79 This ID is unique within a Message Server session. The ID allows the client 
    80 to keep track of different operations. 
    81 
    82 @return The ID of the operation */
    83 	{
    84 	return iId;
    85 	}
    86 
    87 inline TMsvId CMsvOperation::Service() const
    88 /** Gets the ID of the service that is associated with this operation.
    89 
    90 If the operation is not associated with a service, the function returns KMsvLocalServiceIndexEntryId.
    91 
    92 @return ID of the service associated with the operation */
    93 	{
    94 	return iService;
    95 	}