epoc32/include/msvapi.inl
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
     1.1 --- a/epoc32/include/msvapi.inl	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/msvapi.inl	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,95 @@
     1.4 -msvapi.inl
     1.5 +// Copyright (c) 1998-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +// All rights reserved.
     1.7 +// This component and the accompanying materials are made available
     1.8 +// 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
     1.9 +// which accompanies this distribution, and is available
    1.10 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.11 +//
    1.12 +// Initial Contributors:
    1.13 +// Nokia Corporation - initial contribution.
    1.14 +//
    1.15 +// Contributors:
    1.16 +//
    1.17 +// Description:
    1.18 +// CMsvSession
    1.19 +// CMsvEntry
    1.20 +// 
    1.21 +//
    1.22 +
    1.23 +inline TMsvId CMsvEntry::EntryId() const
    1.24 +/** Gets the ID of the context.
    1.25 +
    1.26 +@return Current context's entry ID */
    1.27 +	{
    1.28 +	return iEntryPtr->Id();
    1.29 +	}
    1.30 +
    1.31 +inline const TMsvEntry& CMsvEntry::Entry() const
    1.32 +/** Gets the index entry for the context.
    1.33 +
    1.34 +@return Current context's index entry */
    1.35 +	{
    1.36 +	return *iEntryPtr;
    1.37 +	}
    1.38 +
    1.39 +inline CMsvSession& CMsvEntry::Session()
    1.40 +/** Gets the Message Server session used by this object. This is the same session 
    1.41 +passed by the client in NewL(). 
    1.42 +
    1.43 +@return The session used by the object */
    1.44 +	{
    1.45 +	return iMsvSession;
    1.46 +	}
    1.47 +
    1.48 +inline const TMsvSelectionOrdering& CMsvEntry::SortType() const
    1.49 +/** Gets the current sort order of children of the entry. The sort order is initially 
    1.50 +set through NewL().
    1.51 +
    1.52 +@return Current sort order */
    1.53 +	{
    1.54 +	return iOrdering;
    1.55 +	}
    1.56 +
    1.57 +inline TInt CMsvEntry::Count() const
    1.58 +/** Gets the number of children of the context.
    1.59 +
    1.60 +@return Count of the child entries for the current context */
    1.61 +	{
    1.62 +	return iSortedChildren->Count();
    1.63 +	}
    1.64 +
    1.65 +inline TMsvId CMsvEntry::OwningService() const
    1.66 +/** Gets the ID of the service entry that owns the context. 
    1.67 +
    1.68 +Local entries are considered as being members of the local service: 
    1.69 +
    1.70 +@return ID of the service entry that the context is under. */
    1.71 +	{
    1.72 +	return iOwningService;
    1.73 +	}
    1.74 +
    1.75 +
    1.76 +//**********************************
    1.77 +// CMsvOperation
    1.78 +//**********************************
    1.79 +
    1.80 +inline TMsvOp CMsvOperation::Id() const
    1.81 +/** Gets the operation ID. 
    1.82 +
    1.83 +This ID is unique within a Message Server session. The ID allows the client 
    1.84 +to keep track of different operations. 
    1.85 +
    1.86 +@return The ID of the operation */
    1.87 +	{
    1.88 +	return iId;
    1.89 +	}
    1.90 +
    1.91 +inline TMsvId CMsvOperation::Service() const
    1.92 +/** Gets the ID of the service that is associated with this operation.
    1.93 +
    1.94 +If the operation is not associated with a service, the function returns KMsvLocalServiceIndexEntryId.
    1.95 +
    1.96 +@return ID of the service associated with the operation */
    1.97 +	{
    1.98 +	return iService;
    1.99 +	}