Symbian^3 Application Developer Library >

RFileFlogger Class Reference

class RFileFlogger

Test

Public Member Functions
RFileFlogger ()
~RFileFlogger ()
IMPORT_C void Close ()
IMPORT_C TInt Connect ()
IMPORT_C TInt CreateLog (const TDesC &, TLogMode )
IMPORT_C void Log (const TText8 *, TInt , TLogSeverity , TRefByValue < const TDesC >, ...)
IMPORT_C void Log (const TText8 *, TInt , TLogSeverity , TInt , TExtraLogField *, TRefByValue < const TDesC >, ...)
IMPORT_C void Log (const TText8 *, TInt , TLogSeverity , TRefByValue < const TDesC >, VA_LIST )
IMPORT_C void Log (const TText8 *, TInt , TLogSeverity , TInt , TExtraLogField *, TRefByValue < const TDesC >, VA_LIST )
IMPORT_C void SetLogLevel ( TLogSeverity )
Private Member Functions
void AddTime ( TDes8 &)
void GetCPPModuleName ( TDes &, const TText8 *)
void WriteL (const TDesC &)
void WriteL ( TDes8 &)
Public Member Enumerations
enum TLogCommand { ECreateLog , EWriteLog }
enum TLogMode { ELogModeAppend , ELogModeOverWrite }
enum TLogSeverity {
ESevrErr  = 1, ESevrHigh , ESevrWarn , ESevrMedium , ESevrInfo , ESevrLow , ESevrTEFUnit , ESevrAll
}
enum TLogType { EXml , ETxt }
Private Attributes
TBool iLogfileTag
RFileLoggerBody * ilogbody
TLogSeverity iloglevel

Constructor & Destructor Documentation

RFileFlogger()

IMPORT_C RFileFlogger ( )

Create a new flogger client interface object with an empty body.

~RFileFlogger()

IMPORT_C ~RFileFlogger ( )

Destructor

Member Functions Documentation

AddTime(TDes8 &)

void AddTime ( TDes8 & aTime ) [private]

Parameters

TDes8 & aTime

Close()

IMPORT_C void Close ( )

Connect()

IMPORT_C TInt Connect ( )

CreateLog(const TDesC &, TLogMode)

IMPORT_C TInt CreateLog ( const TDesC & aLogFilePath,
TLogMode aMode
)

Parameters

const TDesC & aLogFilePath - Full path and filename of the log file
TLogMode aMode - Overwrite or Append Makes synchronous call to the log server to create a log session

GetCPPModuleName(TDes &, const TText8 *)

void GetCPPModuleName ( TDes & aModuleName,
const TText8 * aCPPFileName
) [private]

Parameters

TDes & aModuleName
const TText8 * aCPPFileName

Log(const TText8 *, TInt, TLogSeverity, TRefByValue< const TDesC >, ...)

IMPORT_C void Log ( const TText8 * aFile,
TInt aLine,
TLogSeverity aSeverity,
TRefByValue < const TDesC > aFmt,
...
)

Parameters

const TText8 * aFile - Source file name
TInt aLine - Source file line number
TLogSeverity aSeverity - ERR, WARN, INFO
TRefByValue < const TDesC > aFmt - UNICODE format string
...

Log(const TText8 *, TInt, TLogSeverity, TInt, TExtraLogField *, TRefByValue< const TDesC >, ...)

IMPORT_C void Log ( const TText8 * aFile,
TInt aLine,
TLogSeverity aSeverity,
TInt arraylength,
TExtraLogField * aLogFields,
TRefByValue < const TDesC > aFmt,
...
)

Parameters

const TText8 * aFile - Source file name
TInt aLine - Source file line number
TLogSeverity aSeverity - ERR, WARN, INFO
TInt arraylength
TExtraLogField * aLogFields
TRefByValue < const TDesC > aFmt - UNICODE format string
...

Log(const TText8 *, TInt, TLogSeverity, TRefByValue< const TDesC >, VA_LIST)

IMPORT_C void Log ( const TText8 * aFile,
TInt aLine,
TLogSeverity aSeverity,
TRefByValue < const TDesC > aFmt,
VA_LIST aList
)

Parameters

const TText8 * aFile
TInt aLine
TLogSeverity aSeverity
TRefByValue < const TDesC > aFmt
VA_LIST aList

Log(const TText8 *, TInt, TLogSeverity, TInt, TExtraLogField *, TRefByValue< const TDesC >, VA_LIST)

IMPORT_C void Log ( const TText8 * aFile,
TInt aLine,
TLogSeverity aSeverity,
TInt arraylength,
TExtraLogField * aLogFields,
TRefByValue < const TDesC > aFmt,
VA_LIST aList
)

Format a log output line

Parameters

const TText8 * aFile - Source file name
TInt aLine - Source file line number
TLogSeverity aSeverity - ERR, WARN, INFO
TInt arraylength
TExtraLogField * aLogFields
TRefByValue < const TDesC > aFmt - UNICODE format string
VA_LIST aList - Variable argument list

SetLogLevel(TLogSeverity)

IMPORT_C void SetLogLevel ( TLogSeverity aloglevel )

Parameters

TLogSeverity aloglevel

WriteL(const TDesC &)

void WriteL ( const TDesC & aLogBuffer ) [private]

Parameters

const TDesC & aLogBuffer - UNICODE buffer

WriteL(TDes8 &)

void WriteL ( TDes8 & aLogBuffer ) [private]

Synchronous write to the server

Parameters

TDes8 & aLogBuffer - pre-formatted narrow buffer

Member Enumerations Documentation

Enum TLogCommand

Enumerators

ECreateLog
EWriteLog

Enum TLogMode

Enumerators

ELogModeAppend
ELogModeOverWrite

Enum TLogSeverity

Enumerators

ESevrErr = 1
ESevrHigh
ESevrWarn
ESevrMedium
ESevrInfo
ESevrLow
ESevrTEFUnit
ESevrAll

Enum TLogType

Enumerators

EXml
ETxt

Member Data Documentation

TBool iLogfileTag

TBool iLogfileTag [private]

RFileLoggerBody * ilogbody

RFileLoggerBody * ilogbody [private]

TLogSeverity iloglevel

TLogSeverity iloglevel [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.