SysMessagesCollection Class

In This Topic

Inheritance Hierarchy
Syntax
Remarks
Example
Public Constructors
Public Properties
Public Methods
See Also

Class that represents the system-wide message tree. The collection contains the system messages as BaseException objects.

Inheritance Hierarchy

System.Object
Eplan.EplApi.Base.SysMessagesCollection

Syntax

C#
C++/CLI

public class SysMessagesCollection

public ref class SysMessagesCollection

Remarks

It is called a message tree, because each message (BaseException) may contain a further inner exception. Only messages of type "Message", "Warning", "Error", and "Fatal Error" are listed. "Assert" and "Trace" are not added to the SysMessagesCollection. Normally Consecutive messages with the same text (i.e. error description) are joined into one item in the system's message tree. Therefore the count of messages in the collection may be different then the count of generated messages. The contents of the collection does not depend on the logging mode, which you can configure either by the "Diagnose dialog" in EPLAN or by the ELogFileConfigToolu.exe in the bin folder of the respective product variant. The logging mode only influences the EplLog.txt file. In advanced logging mode the EplLog.txt file also contains Asserts and Traces. If the logging is set to immediate mode, identical consecutive messages are not joined.

Example

Example of looping over the SysMessagesCollection For further examples, see also in SysMessagesEnumerator class.

// check, whether errors occurred
int nBookmark = new Eplan.EplApi.Base.BaseException().GetBookmarkID();
Eplan.EplApi.Base.SysMessagesCollection colSysMsg = new Eplan.EplApi.Base.SysMessagesCollection(nBookmark, Eplan.EplApi.Base.MessageLevel.Error);
foreach(Eplan.EplApi.Base.BaseException osysMsg in colSysMsg)
{

	if (osysMsg != null)
	{
		Console.WriteLine("Fehler: " + osysMsg.ToString());
	}
}

Public Constructors

	Name	Description
	SysMessagesCollection Constructor	Overloaded.

Top

Public Properties

	Name	Description
	BookmarkIDEnd
	BookmarkIDStart
	Count	Gets the number of elements contained in the `SysMessagesCollection`.

Top

Public Methods

	Name	Description
	GetEnumerator	Returns an enumerator that can iterate through a collection.
	GetSysMsgEnumerator	Returns a typed enumerator that can iterate through a collection.

Top

Reference

SysMessagesCollection Members
Eplan.EplApi.Base Namespace

Send Feedback