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

// Copyright (c) 1998-2009 Nokia Corporation and/or its subsidiary(-ies).
// All rights reserved.
// This component and the accompanying materials are made available
// 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
// which accompanies this distribution, and is available
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
//
// Initial Contributors:
// Nokia Corporation - initial contribution.
//
// Contributors:
//
// Description:
//




/**
 @file
 
 Tests whether the Log Engine is installed.
 
 @publishedAll
 @released
 @return True if there is a Log Engine, otherwise false 
 
*/
inline TBool CSmsEventLogger::ClientAvailable() const
	{
	return iLogWrapper->ClientAvailable();
	}


/**
 *  Gets a standard string from the specified resource.
 *  
 *  @publishedAll
 *  @released
 *  @param aString On return, string read from resource
 *  @param aId Resource ID
 *  @return KErrNone, if successful; otherwise, one of the other system wide error
 *  codes 
 */
inline TInt CSmsEventLogger::GetString(TDes& aString, TInt aId) const
	{
	return iLogWrapper->Log().GetString(aString,aId);
	}


/**
 *  Gets the current log event.
 *  
 *  @publishedAll
 *  @released
 *  @return Current log event 
 */
inline CLogEvent& CSmsEventLogger::Event()
	{
	return *iLogEvent;
	}


/**
 *  Gets the current (const) log event.
 *  
 *  @publishedAll
 *  @released
 *  @return Current log event 
 */
inline const CLogEvent& CSmsEventLogger::Event() const
	{
	return *iLogEvent;
	}


/**
 *  Gets the current event's SMS PDU data.
 *  
 *  @publishedAll
 *  @released
 *  @return Current event's SMS PDU data 
 */
inline const TLogSmsPduData& CSmsEventLogger::SmsPDUData() const
	{
	return iSmsPDUData;
	}


/**
 *  Gets the current event's SMS PDU data.
 *  @internalComponent
 */
inline void CSmsEventLogger::GetStringL(TDes& aString, TInt aId) const
	{
	User::LeaveIfError(iLogWrapper->Log().GetString(aString,aId));
	}