IlsLogfile::MsgDescription

Category

Nested class

Description

This class is nested in the utility class IlsLogfile. It gives access to the characteristics of the messages handled by the class IlsLogfile.

Libraries

Header File

#include <ilserver/logfile.h>

Synopsis

class MsgDescription{

public:

IlsString getProduct() const;

CategoryId getCategory() const;

MessageId getMessageId() const;

IlsString getResult(IlbBoolean inFull = IlbFalse) const;

IlsString getMessageBody() const;

IlsLogLevel getMsgLevel() const;

};

Member Functions

IlsString MsgDescription::getProduct() const;

This member function returns the name of the product that raised the message (by default, “ILS”).

CategoryId MsgDescription::getCategory() const;

This member function returns the category of the message.

MessageId MsgDescription::getMessageId() const;

This member function returns the error number of the message.

IlsString MsgDescription::getResult(IlsBoolean inFull = IlsFalse)const;

This member function returns the expanded error message. If the Boolean argument inFull is set to IlsTrue, the error message includes the product, the category and the error number.

IlsString MsgDescription::getMessageBody() const;

This member function returns the body of the message. The body of the message is just the text of the error message without the information contained in the message description.

IlsLogLevel getMsgLevel() const;

This member function returns the level of the message as defined by the enumerated type IlsLogLevel.