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.
williamr@2
     1
// Copyright (c) 1998-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@2
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
//
williamr@2
    15
williamr@2
    16
/**
williamr@2
    17
 @file
williamr@2
    18
 
williamr@2
    19
 Tests whether the Log Engine is installed.
williamr@2
    20
 
williamr@2
    21
 @publishedAll
williamr@2
    22
 @released
williamr@2
    23
 @return True if there is a Log Engine, otherwise false 
williamr@2
    24
 
williamr@2
    25
*/
williamr@2
    26
inline TBool CSmsEventLogger::ClientAvailable() const
williamr@4
    27
    {
williamr@4
    28
    return iLogWrapper->ClientAvailable();
williamr@4
    29
    }
williamr@2
    30
williamr@2
    31
/**
williamr@2
    32
 *  Gets a standard string from the specified resource.
williamr@2
    33
 *  
williamr@2
    34
 *  @publishedAll
williamr@2
    35
 *  @released
williamr@2
    36
 *  @param aString On return, string read from resource
williamr@2
    37
 *  @param aId Resource ID
williamr@2
    38
 *  @return KErrNone, if successful; otherwise, one of the other system wide error
williamr@2
    39
 *  codes 
williamr@2
    40
 */
williamr@2
    41
inline TInt CSmsEventLogger::GetString(TDes& aString, TInt aId) const
williamr@4
    42
    {
williamr@4
    43
    return iLogWrapper->Log().GetString(aString,aId);
williamr@4
    44
    }
williamr@2
    45
williamr@2
    46
/**
williamr@2
    47
 *  Gets the current log event.
williamr@2
    48
 *  
williamr@2
    49
 *  @publishedAll
williamr@2
    50
 *  @released
williamr@2
    51
 *  @return Current log event 
williamr@2
    52
 */
williamr@2
    53
inline CLogEvent& CSmsEventLogger::Event()
williamr@4
    54
    {
williamr@4
    55
    return *iLogEvent;
williamr@4
    56
    }
williamr@2
    57
williamr@2
    58
/**
williamr@2
    59
 *  Gets the current (const) log event.
williamr@2
    60
 *  
williamr@2
    61
 *  @publishedAll
williamr@2
    62
 *  @released
williamr@2
    63
 *  @return Current log event 
williamr@2
    64
 */
williamr@2
    65
inline const CLogEvent& CSmsEventLogger::Event() const
williamr@4
    66
    {
williamr@4
    67
    return *iLogEvent;
williamr@4
    68
    }
williamr@2
    69
williamr@2
    70
/**
williamr@2
    71
 *  Gets the current event's SMS PDU data.
williamr@2
    72
 *  
williamr@2
    73
 *  @publishedAll
williamr@2
    74
 *  @released
williamr@2
    75
 *  @return Current event's SMS PDU data 
williamr@2
    76
 */
williamr@2
    77
inline const TLogSmsPduData& CSmsEventLogger::SmsPDUData() const
williamr@4
    78
    {
williamr@4
    79
    return iSmsPDUData;
williamr@4
    80
    }
williamr@2
    81
williamr@2
    82
/**
williamr@2
    83
 *  Gets the current event's SMS PDU data.
williamr@4
    84
 *  @publishedAll
williamr@2
    85
 */
williamr@2
    86
inline void CSmsEventLogger::GetStringL(TDes& aString, TInt aId) const
williamr@4
    87
    {
williamr@4
    88
    User::LeaveIfError(iLogWrapper->Log().GetString(aString,aId));
williamr@4
    89
    }