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