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