---

     

---

IGClogMessage Class Reference

#include <IGClogMessage.h>

---

Detailed Description

This class is used to represent an individual Iguana log message.

Public Member Functions
	IGClogMessage ()
	Constructor.
virtual	~IGClogMessage ()
	Destructor.
IGClogMessage &	operator= (const IGClogMessage &Orig)
	Assignment operator.
IGClogMessageHandle	GetHandle () const
	This method is part of the internal implementation of this class and should not be called.
const char *	ChannelName () const
	Provides the name of the source channel associated with the message, or an empty string if the message is not associated with a specific channel.
const char *	MessageType () const
	Provides the type of this message (Message/Ack/Success/Warning/Error/Info/Debug).
const char *	Content () const
	Provides the full body of the message.
const char *	MessageLogId () const
	Provides the ID that is used to uniquely identify this message.
const char *	ReferenceLogId () const
	Provides the ID of the parent of this message.
time_t	TimeStamp () const
	Provides a timestamp of the message with second precision.
IGCint32	Milliseconds () const
	Provides the number of milliseconds (0-999) associated with the IGClogMessage::TimeStamp property.
IGCboolean	Deleted () const
	This flag is set if the message has been deleted through Iguana dashboard by an administrator.
IGCboolean	MarkedError () const
	This flag is set if this error has been marked (acknowledged) through Iguana dashboard by an administrator.
IGCboolean	Resubmitted () const
	This flag is set if this message is the original of a separate resubmitted message.
IGCboolean	IsResubmission () const
	This flag is set if this message is a re-submission of an earlier message.

---

Constructor & Destructor Documentation

IGClogMessage::IGClogMessage (   )

Constructor.

virtual IGClogMessage::~IGClogMessage (   )  [virtual]

Destructor.

---

Member Function Documentation

const char* IGClogMessage::ChannelName (   )  const

Provides the name of the source channel associated with the message, or an empty string if the message is not associated with a specific channel.

const char* IGClogMessage::Content (   )  const

Provides the full body of the message.

IGCboolean IGClogMessage::Deleted (   )  const

This flag is set if the message has been deleted through Iguana dashboard by an administrator.

IGClogMessageHandle IGClogMessage::GetHandle (   )  const [inline]

This method is part of the internal implementation of this class and should not be called.

IGCboolean IGClogMessage::IsResubmission (   )  const

This flag is set if this message is a re-submission of an earlier message. (Only applicable to message Type Message)

IGCboolean IGClogMessage::MarkedError (   )  const

This flag is set if this error has been marked (acknowledged) through Iguana dashboard by an administrator. (Only applicable to message type Error)

const char* IGClogMessage::MessageLogId (   )  const

Provides the ID that is used to uniquely identify this message. This ID can be used to query related messages.

const char* IGClogMessage::MessageType (   )  const

Provides the type of this message (Message/Ack/Success/Warning/Error/Info/Debug).

IGCint32 IGClogMessage::Milliseconds (   )  const

Provides the number of milliseconds (0-999) associated with the IGClogMessage::TimeStamp property.

IGClogMessage& IGClogMessage::operator= (  const IGClogMessage &  Orig  )

Assignment operator.

const char* IGClogMessage::ReferenceLogId (   )  const

Provides the ID of the parent of this message. It will be empty if there is no parent.

IGCboolean IGClogMessage::Resubmitted (   )  const

This flag is set if this message is the original of a separate resubmitted message. (Only applicable to message Type Message)

time_t IGClogMessage::TimeStamp (   )  const

Provides a timestamp of the message with second precision. Milliseconds are available via the IGClogMessage::Milliseconds property.

---

The documentation for this class was generated from the following file:

• IGClogMessage.h

---