epoc32/include/smsulog.inl
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000 (2010-03-16)
branchSymbian2
changeset 2 2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
     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 //
    15 
    16 
    17 
    18 
    19 /**
    20  @file
    21  
    22  Tests whether the Log Engine is installed.
    23  
    24  @publishedAll
    25  @released
    26  @return True if there is a Log Engine, otherwise false 
    27  
    28 */
    29 inline TBool CSmsEventLogger::ClientAvailable() const
    30 	{
    31 	return iLogWrapper->ClientAvailable();
    32 	}
    33 
    34 
    35 /**
    36  *  Gets a standard string from the specified resource.
    37  *  
    38  *  @publishedAll
    39  *  @released
    40  *  @param aString On return, string read from resource
    41  *  @param aId Resource ID
    42  *  @return KErrNone, if successful; otherwise, one of the other system wide error
    43  *  codes 
    44  */
    45 inline TInt CSmsEventLogger::GetString(TDes& aString, TInt aId) const
    46 	{
    47 	return iLogWrapper->Log().GetString(aString,aId);
    48 	}
    49 
    50 
    51 /**
    52  *  Gets the current log event.
    53  *  
    54  *  @publishedAll
    55  *  @released
    56  *  @return Current log event 
    57  */
    58 inline CLogEvent& CSmsEventLogger::Event()
    59 	{
    60 	return *iLogEvent;
    61 	}
    62 
    63 
    64 /**
    65  *  Gets the current (const) log event.
    66  *  
    67  *  @publishedAll
    68  *  @released
    69  *  @return Current log event 
    70  */
    71 inline const CLogEvent& CSmsEventLogger::Event() const
    72 	{
    73 	return *iLogEvent;
    74 	}
    75 
    76 
    77 /**
    78  *  Gets the current event's SMS PDU data.
    79  *  
    80  *  @publishedAll
    81  *  @released
    82  *  @return Current event's SMS PDU data 
    83  */
    84 inline const TLogSmsPduData& CSmsEventLogger::SmsPDUData() const
    85 	{
    86 	return iSmsPDUData;
    87 	}
    88 
    89 
    90 /**
    91  *  Gets the current event's SMS PDU data.
    92  *  @internalComponent
    93  */
    94 inline void CSmsEventLogger::GetStringL(TDes& aString, TInt aId) const
    95 	{
    96 	User::LeaveIfError(iLogWrapper->Log().GetString(aString,aId));
    97 	}