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