RFileLogger Class Reference

Creates a default RFileLogger object.

Empty destructor. Clients with open sessions must end the session by calling Close() beforehand. Note that it does not delete the log file.

Closes the log file, iLogFile.

This function closes the log file previously created or opened by CreateLog().

Connects to the file logger server with the default number of message slots, which is 8.

This function does not need to be called if you are using the static versions of Write(), WriteFormat() or HexDump().

Creates or opens a file for logging.

When specifying a directory for logging only specify the relative path to 'C:\Logs\' and do not append a '\' to the end of the path either. CreateLog() only creates the specified log file if the directory exists. This means that switching logging on and off can be achieved without having to re-compile, by just removing or renaming the log directory.

aLogFile.iValid is set according to whether logging will actually occur or not.

Writes a hex dump of the specified data to the log.

The format of the hex dump entry is a header followed by the hex string of the data followed by any printable characters (non printable characters are substituted with '.'). For example,

RLog_Ex0000 : 41 42 6C 6B 0A 0A 45 46 20 20 78 7A                       ABlk..EF 
 xz
RL_cont0001 : 43 44 6C 6B 0A 0A 45 46 20 20 78 7A                       CDlk..EF 
 xz
RL_cont0002 : 45 46 6C 6B 0A 0A 47 48 20 20 78 7A                       EFlk..GH 
 xz
.
.
.

Writes a hex dump of the specified data to the log.

The format of the hex dump entry is a header followed by the hex string of the data followed by any printable characters (non printable characters are substituted with '.'). For example,

RLog_Ex0000 : 41 42 6C 6B 0A 0A 45 46 20 20 78 7A                       ABlk..EF 
 xz
RL_cont0001 : 43 44 6C 6B 0A 0A 45 46 20 20 78 7A                       CDlk..EF 
 xz
RL_cont0002 : 45 46 6C 6B 0A 0A 47 48 20 20 78 7A                       EFlk..GH 
 xz
.
.
.

Returns the last error status that has been set.

Returns patchable constant value.

Returns the status of the log.

Specifies whether time and/or date should be appended to log data.

Appending of the time and date to log entries can be switched on and off at anytime between creation and destruction of RFileLogger.

This function does not need to be called if you are using the static versions of Write(), WriteFormat() or HexDump().

Returns the version number.

Writes a string of Unicode characters to an open log, iLogFile, if it is a valid file.

Note that the text will be converted to an 8 bit format for the log file.

Writes a string of 8-bit characters to an open log, iLogFile, if it is a valid file.

Writes a string of 16-bit characters to an open log.

Connects to the logging server, creates/opens the log file and write aText to it.

This is a "static write".

Note that the text will be converted to an 8 bit format for the log file.

Writes a string of 8-bit characters to an open log.

Connects to the logging server, creates/opens the log file and writes aText to it.

This is a "static write".

Formats the remaining arguments of the function according to aFmt, and writes the result to the log, iLogFile, if it is a valid file.

The format string aFmt contains literal text, embedded with directives, for converting the trailing list of arguments into text. The number and type of arguments is dictated by the structure of the directives in aFmt.

Note that the text will be converted to an 8 bit format for the log file.

Formats the arguments pointed to by aList according to aFmt, and writes the result to the log, iLogFile, if it is a valid file.

The format string aFmt contains literal text, embedded with directives, for converting the trailing list of arguments into text. The number and type of arguments pointed to by aList is dictated by the structure of the directives in aFmt.

Note that the text will be converted to an 8 bit format for the log file.

Formats the remaining arguments of the function according to aFmt, and writes the result to the log, iLogFile, if it is a valid file.

The format string aFmt contains literal text, embedded with directives, for converting the trailing list of arguments into text. The number and type of arguments is dictated by the structure of the directives in aFmt.

Formats the arguments pointed to by aList according to aFmt, and writes the result to the log, iLogFile, if it is a valid file.

The format string aFmt contains literal text, embedded with directives, for converting the trailing list of arguments into text. The number and type of arguments pointed to by aList is dictated by the structure of the directives in aFmt.

Formats the remaining arguments of the function according to aFmt and writes the result to the log.

The format string aFmt contains literal text, embedded with directives, for converting the trailing list of arguments into text. The number and type of arguments is dictated by the structure of the directives in aFmt.

Connects to the logging server, creates/opens the log file and writes the text arguments to it.

This is a "static write".

Note that the text will be converted to an 8 bit format for the log file.

Formats the arguments pointed to by aList according to aFmt, and writes the result to the log.

The format string aFmt contains literal text, embedded with directives, for converting the trailing list of arguments into text. The number and type of arguments pointed to by aList is dictated by the structure of the directives in aFmt.

Connects to the logging server, creates/opens the log file and writes the text arguments to it.

This is a "static write".

Note that the text will be converted to an 8 bit format for the log file.

Formats the remaining arguments of the function according to aFmt and writes the result to the log.

The format string aFmt contains literal text, embedded with directives, for converting the trailing list of arguments into text. The number and type of arguments is dictated by the structure of the directives in aFmt.

Connects to the logging server, creates/opens the log file and writes the text arguments to it.

This is a "static write".

Formats the arguments pointed to by aList according to aFmt, and writes the result to the log.

The format string aFmt contains literal text, embedded with directives, for converting the trailing list of arguments into text. The number and type of arguments pointed to by aList is dictated by the structure of the directives in aFmt.

Connects to the logging server, creates/opens the log file and writes the text arguments to it.

This is a "static write".