Server
API Reference Guide
Product Documentation:

Visualization Server
Documentation Home
List of all members | Public Member Functions | Friends
IlsLogfile::MsgDescription Class Reference

Gives access to the characteristics of the messages handled by the class IlsLogfile. More...

#include <ilserver/logfile.h>

Public Member Functions

CategoryId getCategory () const
 Returns the category of the message.
 
IlsString getMessageBody () const
 Returns the body of the message. More...
 
MessageId getMessageId () const
 Returns the error number of the message.
 
IlsLogLevel getMsgLevel () const
 Returns the level of the message as defined by the enumerated type IlsLogLevel.
 
IlsString getProduct () const
 Returns the name of the product that raised the message (by default, "ILS").
 
IlsString getResult (IlsBoolean inFull=IlsFalse) const
 Returns the expanded error message. More...
 

Friends

class IlsLogfile
 

Detailed Description

Gives access to the characteristics of the messages handled by the class IlsLogfile.

Library: server
and mvcomp

See also
IlsLogfile.

Member Function Documentation

◆ getMessageBody()

IlsString IlsLogfile::MsgDescription::getMessageBody ( ) const

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.

◆ getResult()

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

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.