Consultingwerk.Util.LoggingStream.SerializableLongcharLoggingStream

Namespace:

Consultingwerk.Util.LoggingStream

Class

SerializableLongcharLoggingStream

Parent classes:

Progress.Lang.Object

Consultingwerk.JsonSerializable

Consultingwerk.Util.LoggingStream.SerializableLongcharLoggingStream

Inherits:

Consultingwerk.JsonSerializable

Implements:

Consultingwerk.IJsonSerializable, Consultingwerk.Util.LoggingStream.ILoggingStream

File:	SerializableLongcharLoggingStream
Purpose:	Serializable variant of the LongcharLoggingStream
Author(s):	Mike Fechner / Consultingwerk Ltd.
Created:	09.07.2018 22:49:00

Top Method Summary

Options	Name	Purpose
+	AddCustomLogEntries (character)	Adds a comma delimited list of custom log entries to the CustomLogEntries List
#	AddSerializableProperties ()	Adds serializable properties from the calling class using ABL reflection. Supported from OpenEdge 11.6 on only. Inherited from Consultingwerk.JsonSerializable
#	AddSerializableProperties (character)	Add a list of Serializable Properties to the SerializableProperties property Inherited from Consultingwerk.JsonSerializable
#	AddSerializableProperties (Class)	Adds serializable properties from the given class using ABL reflection. Supported from OpenEdge 11.6 on only. Inherited from Consultingwerk.JsonSerializable
+	ClearLogFile ()	Clears the logfile.
+	Deserialize (longchar)	Deserializes a LONGCHAR representation of the state of the class instance Inherited from Consultingwerk.JsonSerializable
+	DeserializeFromJsonObject (JsonObject)	Initializes the object instance based on the passed in JsonObject representation of the object instance Inherited from Consultingwerk.JsonSerializable
#	DeserializeProperty (JsonObject, character, character)	Deserializes a single property value to the current JsonObject Overrides Consultingwerk.JsonSerializable:DeserializeProperty (JsonObject, character, character)
+	LONGCHAR GetLongchar ()	Returns the logging messages
+	CHARACTER GetSerializableProperties ()	Returns the meta data of the serializable properties Inherited from Consultingwerk.JsonSerializable
+	LOGICAL IsCustomLogEntryTypeActive (character)	Verifies if a custom log entry (optionally with logging level) is active
+	RemoveCustomLogEntries (character)	Removes a comma delimited list of custom log entries from the CustomLogEntries List
+	LONGCHAR Serialize ()	Returns a LONGCHAR representation of the state of the class instance Inherited from Consultingwerk.JsonSerializable
#	SerializeProperty (JsonObject, character, character)	Serializes a single property value to the current JsonObject Inherited from Consultingwerk.JsonSerializable
+	Progress.Json.ObjectModel.JsonObject ToJsonObject ()	Returns a JsonObject representation of the state of the class instance Inherited from Consultingwerk.JsonSerializable
+	WriteBuffer (handle, logical)	Dumps a buffer's fields to the current logfile.
+	WriteError (Error)	Writes details about an Error object (exception) to the client logfile
+	WriteError (Error, character)	Writes details about an Error object (exception) to the client logfile
+	WriteFormattedMessage (character, character)	Writes a character message to the client logile and the default logging sub system.
+	WriteFormattedMessage (character, character, character)	Writes a character message to the client logile and the default logging sub system.
+	WriteFormattedMessage (character, character, character, character)	Writes a character message to the client logile and the default logging sub system.
+	WriteFormattedMessage (character, character, character, character, character)	Writes a character message to the client logile and the default logging sub system.
+	WriteFormattedMessage (character, character, character, character, character, character)	Writes a character message to the client logile and the default logging sub system.
+	WriteFormattedMessage (character, character, character, character, character, character, character)	Writes a character message to the client logile and the default logging sub system.
+	WriteFormattedMessage (character, character, character, character, character, character, character, character)	Writes a character message to the client logile and the default logging sub system.
+	WriteFormattedMessage (character, character, character, character, character, character, character, character, character)	Writes a character message to the client logile and the default logging sub system.
+	WriteFormattedMessage (character, character, character, character, character, character, character, character, character, character)	Writes a character message to the client logile and the default logging sub system.
+	WriteFormattedMessage (character, character, character, character, character, character, character, character, character, character, MessageSubSystem)	Writes a character message to the client logile and the default logging sub system.
+	WriteFormattedMessage (character, character, character, character, character, character, character, character, character, MessageSubSystem)	Writes a character message to the client logile and the default logging sub system.
+	WriteFormattedMessage (character, character, character, character, character, character, character, character, MessageSubSystem)	Writes a character message to the client logile and the default logging sub system.
+	WriteFormattedMessage (character, character, character, character, character, character, character, MessageSubSystem)	Writes a character message to the client logile and the default logging sub system.
+	WriteFormattedMessage (character, character, character, character, character, character, MessageSubSystem)	Writes a character message to the client logile and the default logging sub system.
+	WriteFormattedMessage (character, character, character, character, character, MessageSubSystem)	Writes a character message to the client logile and the default logging sub system.
+	WriteFormattedMessage (character, character, character, character, MessageSubSystem)	Writes a character message to the client logile and the default logging sub system.
+	WriteFormattedMessage (character, character, character, MessageSubSystem)	Writes a character message to the client logile and the default logging sub system.
+	WriteFormattedMessage (character, character, MessageSubSystem)	Writes a character message to the client logile and the default logging sub system.
+	WriteFormattedMessage (character, date)	Writes a character message to the client logile and the default logging sub system.
+	WriteFormattedMessage (character, date, MessageSubSystem)	Writes a character message to the client logile and the default logging sub system.
+	WriteFormattedMessage (character, datetime)	Writes a character message to the client logile and the default logging sub system.
+	WriteFormattedMessage (character, datetime, MessageSubSystem)	Writes a character message to the client logile and the default logging sub system.
+	WriteFormattedMessage (character, datetime-tz)	Writes a character message to the client logile and the default logging sub system.
+	WriteFormattedMessage (character, datetime-tz, MessageSubSystem)	Writes a character message to the client logile and the default logging sub system.
+	WriteFormattedMessage (character, decimal)	Writes a character message to the client logile and the default logging sub system.
+	WriteFormattedMessage (character, decimal, MessageSubSystem)	Writes a character message to the client logile and the default logging sub system.
+	WriteFormattedMessage (character, int64)	Writes a character message to the client logile and the default logging sub system.
+	WriteFormattedMessage (character, int64, MessageSubSystem)	Writes a character message to the client logile and the default logging sub system.
+	WriteFormattedMessage (character, integer)	Writes a character message to the client logile and the default logging sub system.
+	WriteFormattedMessage (character, integer, MessageSubSystem)	Writes a character message to the client logile and the default logging sub system.
+	WriteFormattedMessage (character, logical)	Writes a character message to the client logile and the default logging sub system.
+	WriteFormattedMessage (character, logical, MessageSubSystem)	Writes a character message to the client logile and the default logging sub system.
+	WriteFormattedMessage (character, recid)	Writes a character message to the client logile and the default logging sub system.
+	WriteFormattedMessage (character, recid, MessageSubSystem)	Writes a character message to the client logile and the default logging sub system.
+	WriteFormattedMessage (character, rowid)	Writes a character message to the client logile and the default logging sub system.
+	WriteFormattedMessage (character, rowid, MessageSubSystem)	Writes a character message to the client logile and the default logging sub system.
+	WriteIgnoredError (Error)	Performs logging for an ignored error (catched but not shown)
+	LONGCHAR WriteJson ()	Returns a LONGCHAR representation of the state of the class instance Inherited from Consultingwerk.JsonSerializable
+	WriteJson (JsonConstruct)	Writes the JSON Construct to the log file
+	WriteJson (JsonConstruct, character)	Writes the JSON Construct to the log file
+	WriteJson (JsonConstruct, MessageSubSystem)	Writes the JSON Construct to the log file
+	WriteMessage (character)	Writes a character message to the client logile and the default logging sub system.
+	WriteMessage (character, character)	Writes a message to the client logfiles
+	WriteMessage (character, MessageSubSystem)	Writes a message to the client logfiles
+	WriteMessage (date)	Writes an date message to the client logile and the default logging sub system.
+	WriteMessage (datetime)	Writes an datetime message to the client logile and the default logging sub system.
+	WriteMessage (decimal)	Writes an decimal message to the client logile and the default logging sub system.
+	WriteMessage (integer)	Writes an integer message to the client logile and the default logging sub system.
+	WriteMessage (logical)	Writes an logical message to the client logile and the default logging sub system.
+	WriteObjectProperties (Object, character)	Writes the properties of a class based object to the open logfile
+	WritePropath ()	Writes the current PROPATH in a tabular fashion to the log file
+	WriteSeparator ()	Writes a line full of ------------- into the current logfile
+	WriteStackTrace ()	Writes the current stack trace to the log file
+	WriteWidgetChain (handle)	Dumps all widgets in the given SESSION:FIRST-... chain to the logfile
+	WriteWidgetProperties (handle)	Writes the properties of a widget handle to the open logfile
+	WriteWidgetProperties (handle, character)	Writes the properties of a widget handle to the open logfile
+	LONGCHAR WriteXml ()	Returns an XML LONGCHAR representation of the object instance Inherited from Consultingwerk.JsonSerializable
+	HANDLE XmlSerialize (handle)	Serializes the properties of the current object instance to an existing X-NODEREF object Inherited from Consultingwerk.JsonSerializable
+	XmlSerializeProperties (handle)	Serializes the properties of this object instance as child nodes of the given node Inherited from Consultingwerk.JsonSerializable
#	XmlSerializeProperty (handle, character, character)	Serializes a single property value to the current parent XmlNode Inherited from Consultingwerk.JsonSerializable

Top Constructor Summary

	Options	Name	Purpose
	+	SerializableLongcharLoggingStream ()	Constructor for the SerializableLongcharLoggingStream class

Top Property Summary

Options	Name	Purpose
+	CHARACTER CustomLogEntries
#	LONGCHAR Data
+	Consultingwerk.IJsonDateTypeFormatter JsonDateTypeFormatter	Inherited from Consultingwerk.JsonSerializable
+	LOGICAL SerializeEmptyLists	Inherited from Consultingwerk.JsonSerializable
+	LOGICAL SerializeNullValues	Inherited from Consultingwerk.JsonSerializable
+	LOGICAL UseSerializedTypeInformation	Inherited from Consultingwerk.JsonSerializable

Method Detail

Top

PUBLIC AddCustomLogEntries (character)

Purpose:	Adds a comma delimited list of custom log entries to the
	CustomLogEntries List
Notes:	Does silently ignore entries that are already part of the list

Parameters:
pcEntries	CHARACTER
	The comma delimited list of custom log entries to add

Top

PROTECTED AddSerializableProperties ()

Inherited from Consultingwerk.JsonSerializable

Purpose:	Adds serializable properties from the calling class using ABL reflection.
	Supported from OpenEdge 11.6 on only.
Notes:	Adds properties of the following types, does not add properties of
	the base classes, adds only PUBLIC properties:
	- CHARACTER
	- CHARACTER EXTENT
	- DATE
	- DATE EXTENT
	- DATETIME
	- DATETIME EXTENT
	- DATETIME-TZ
	- DATETIME-TZ EXTENT
	- DECIMAL
	- DECIMAL EXTENT
	- INT64
	- INT64 EXTENT
	- INTEGER
	- INTEGER EXTENT
	- LOGICAL
	- LOGICAL EXTENT
	- LONGCHAR
	- LONGCHAR EXTENT
	- RAW
	- RAW EXTENT
	- RECID
	- RECID EXTENT
	- ROWID
	- ROWID EXTENT
	- Progress.Json.ObjectModel.JsonArray
	- Progress.Json.ObjectModel.JsonObject
	- ENUM
	- Consultingwerk.Enum
	- Consultingwerk.JsonSerializable
	- Consultingwerk.Framework.Base.IEnumerable

Top

PROTECTED AddSerializableProperties (character)

Inherited from Consultingwerk.JsonSerializable

Purpose:	Add a list of Serializable Properties to the SerializableProperties property
Notes:	Required as a workaround to full reflection only. We may remove this
	method once Progress Software has implemented full reflection

Parameters:
pcSerializableProperties	CHARACTER
	A comma delimited list of serializable properties

Top

PROTECTED AddSerializableProperties (Class)

Inherited from Consultingwerk.JsonSerializable

Purpose:	Adds serializable properties from the given class using ABL reflection.
	Supported from OpenEdge 11.6 on only.
Notes:	Adds properties of the following types, does not add properties of
	the base classes, adds only PUBLIC properties:
	- CHARACTER
	- CHARACTER EXTENT
	- DATE
	- DATE EXTENT
	- DATETIME
	- DATETIME EXTENT
	- DATETIME-TZ
	- DATETIME-TZ EXTENT
	- DECIMAL
	- DECIMAL EXTENT
	- INT64
	- INT64 EXTENT
	- INTEGER
	- INTEGER EXTENT
	- LOGICAL
	- LOGICAL EXTENT
	- LONGCHAR
	- LONGCHAR EXTENT
	- RAW
	- RAW EXTENT
	- RECID
	- RECID EXTENT
	- ROWID
	- ROWID EXTENT
	- Progress.Json.ObjectModel.JsonArray
	- Progress.Json.ObjectModel.JsonObject
	- ENUM
	- Consultingwerk.Enum
	- Consultingwerk.Framework.Base.IEnumerable
	- Consultingwerk.JsonSerializable

Parameters:
poClass	Progress.Lang.Class
	The declaring class

Top

PUBLIC ClearLogFile ()

Purpose:	Clears the logfile.
Notes:	Errors from the LOG-MANAGER will be caught and ignored.

Top

PUBLIC Deserialize (longchar)

Inherited from Consultingwerk.JsonSerializable

Purpose:	Deserializes a LONGCHAR representation of the state of the class instance
Notes:

Parameters:
pcSerializedReprasentation	LONGCHAR
	The stored LONGCHAR representation of the objects data

Top

PUBLIC DeserializeFromJsonObject (JsonObject)

Inherited from Consultingwerk.JsonSerializable

Purpose:	Initializes the object instance based on the passed in JsonObject
	representation of the object instance
Notes:

Parameters:
poJsonObject	Progress.Json.ObjectModel.JsonObject
	The stored JsonObject representation of the objects data

Top

PROTECTED DeserializeProperty (JsonObject, character, character)

Overrides Consultingwerk.JsonSerializable:DeserializeProperty (JsonObject, character, character)

Purpose:	Deserializes a single property value to the current JsonObject
Notes:	Allows to override the handling of individual properties during the
	JsonSerialization
Notes:

Parameters:
poJsonObject	Progress.Json.ObjectModel.JsonObject
	The reference to the source JsonObject
pcProperty	CHARACTER
	The name of the property in the JsonObject
pcType	CHARACTER
	The type of the property

Top

PUBLIC LONGCHAR GetLongchar ()

Purpose:	Returns the logging messages
Notes:

Returns	LONGCHAR
	The logging string

Top

PUBLIC CHARACTER GetSerializableProperties ()

Inherited from Consultingwerk.JsonSerializable

Purpose:	Returns the meta data of the serializable properties
Notes:

Returns	CHARACTER
	The serializable properties meta data as a comma delimited list

Top

PUBLIC LOGICAL IsCustomLogEntryTypeActive (character)

Purpose:	Verifies if a custom log entry (optionally with logging level)
	is active
Notes:

Parameters:
pcEntry	CHARACTER
	The Log Entry to validate
Returns	LOGICAL
	Logical value indicating if the custom log entry type is activated

Top

PUBLIC RemoveCustomLogEntries (character)

Purpose:	Removes a comma delimited list of custom log entries from the
	CustomLogEntries List
Notes:	Does silently ignore entries that are not part of the list

Parameters:
pcEntries	CHARACTER
	The comma delimited list of custom log entries to remove

Top

PUBLIC LONGCHAR Serialize ()

Inherited from Consultingwerk.JsonSerializable

Purpose:	Returns a LONGCHAR representation of the state of the class instance
Notes:	Returns the classname together with the Json serialization

Returns	LONGCHAR
	The LONGCHAR representation of the ISerializable objects data

Top

PROTECTED SerializeProperty (JsonObject, character, character)

Inherited from Consultingwerk.JsonSerializable

Purpose:	Serializes a single property value to the current JsonObject
Notes:	Allows to override the handling of individual properties during the
	JsonSerialization

Parameters:
poJsonObject	Progress.Json.ObjectModel.JsonObject
	The reference to the target JsonObject
pcProperty	CHARACTER
	The name of the property in the JsonObject
pcType	CHARACTER
	The type of the property

Top

PUBLIC Progress.Json.ObjectModel.JsonObject ToJsonObject ()

Inherited from Consultingwerk.JsonSerializable

Purpose:	Returns a JsonObject representation of the state of the class instance
Notes:	Returns the classname together with the Json serialization of the
	object

Returns	Progress.Json.ObjectModel.JsonObject
	The Progress.Json.ObjectModel.JsonObject representation of the ISerializable objects data

Top

PUBLIC WriteBuffer (handle, logical)

Purpose:	Dumps a buffer's fields to the current logfile.
Notes:

Parameters:
phBuffer	HANDLE
	The handle to the buffer
plFindFirst	LOGICAL
	When plFindFirst is TURE, the method will create an additional buffer for the table and run a FIND-FIRST on that buffer to not change the orignal buffer's position

Top

PUBLIC WriteError (Error)

Purpose:	Writes details about an Error object (exception) to the client
	logfile
Notes:	Uses Consultingwerk.Util.ErrorHelper to format the error message
	and stack trace

Parameters:
poError	Progress.Lang.Error
	The reference to the error object

Top

PUBLIC WriteError (Error, character)

Purpose:	Writes details about an Error object (exception) to the client
	logfile
Notes:	Uses Consultingwerk.Util.ErrorHelper to format the error message
	and stack trace

Parameters:
poError	Progress.Lang.Error
	The reference to the error object
pcMessageSubSys	CHARACTER
	The custom log entry type for the message

Top

PUBLIC WriteFormattedMessage (character, character)

Purpose:	Writes a character message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pcMessagePattern	CHARACTER
	A character message to write to the log file
pcMessageParam	CHARACTER
	A character message parameter to substitute &1

Top

PUBLIC WriteFormattedMessage (character, character, character)

Purpose:	Writes a character message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pcMessagePattern	CHARACTER
	A character message to write to the log file
pcMessageParam1	CHARACTER
	A character message parameter to substitute &1
pcMessageParam2	CHARACTER
	A character message parameter to substitute &2

Top

PUBLIC WriteFormattedMessage (character, character, character, character)

Purpose:	Writes a character message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pcMessagePattern	CHARACTER
	A character message to write to the log file
pcMessageParam1	CHARACTER
	A character message parameter to substitute &1
pcMessageParam2	CHARACTER
	A character message parameter to substitute &2
pcMessageParam3	CHARACTER
	A character message parameter to substitute &3

Top

PUBLIC WriteFormattedMessage (character, character, character, character, character)

Purpose:	Writes a character message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pcMessagePattern	CHARACTER
	A character message to write to the log file
pcMessageParam1	CHARACTER
	A character message parameter to substitute &1
pcMessageParam2	CHARACTER
	A character message parameter to substitute &2
pcMessageParam3	CHARACTER
	A character message parameter to substitute &3
pcMessageParam4	CHARACTER
	A character message parameter to substitute &4

Top

PUBLIC WriteFormattedMessage (character, character, character, character, character, character)

Purpose:	Writes a character message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pcMessagePattern	CHARACTER
	A character message to write to the log file
pcMessageParam1	CHARACTER
	A character message parameter to substitute &1
pcMessageParam2	CHARACTER
	A character message parameter to substitute &2
pcMessageParam3	CHARACTER
	A character message parameter to substitute &3
pcMessageParam4	CHARACTER
	A character message parameter to substitute &4
pcMessageParam5	CHARACTER
	A character message parameter to substitute &5

Top

PUBLIC WriteFormattedMessage (character, character, character, character, character, character, character)

Purpose:	Writes a character message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pcMessagePattern	CHARACTER
	A character message to write to the log file
pcMessageParam1	CHARACTER
	A character message parameter to substitute &1
pcMessageParam2	CHARACTER
	A character message parameter to substitute &2
pcMessageParam3	CHARACTER
	A character message parameter to substitute &3
pcMessageParam4	CHARACTER
	A character message parameter to substitute &4
pcMessageParam5	CHARACTER
	A character message parameter to substitute &5
pcMessageParam6	CHARACTER
	A character message parameter to substitute &6

Top

PUBLIC WriteFormattedMessage (character, character, character, character, character, character, character, character)

Purpose:	Writes a character message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pcMessagePattern	CHARACTER
	A character message to write to the log file
pcMessageParam1	CHARACTER
	A character message parameter to substitute &1
pcMessageParam2	CHARACTER
	A character message parameter to substitute &2
pcMessageParam3	CHARACTER
	A character message parameter to substitute &3
pcMessageParam4	CHARACTER
	A character message parameter to substitute &4
pcMessageParam5	CHARACTER
	A character message parameter to substitute &5
pcMessageParam6	CHARACTER
	A character message parameter to substitute &6
pcMessageParam7	CHARACTER
	A character message parameter to substitute &7

Top

PUBLIC WriteFormattedMessage (character, character, character, character, character, character, character, character, character)

Purpose:	Writes a character message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pcMessagePattern	CHARACTER
	A character message to write to the log file
pcMessageParam1	CHARACTER
	A character message parameter to substitute &1
pcMessageParam2	CHARACTER
	A character message parameter to substitute &2
pcMessageParam3	CHARACTER
	A character message parameter to substitute &3
pcMessageParam4	CHARACTER
	A character message parameter to substitute &4
pcMessageParam5	CHARACTER
	A character message parameter to substitute &5
pcMessageParam6	CHARACTER
	A character message parameter to substitute &6
pcMessageParam7	CHARACTER
	A character message parameter to substitute &7
pcMessageParam8	CHARACTER
	A character message parameter to substitute &8

Top

PUBLIC WriteFormattedMessage (character, character, character, character, character, character, character, character, character, character)

Purpose:	Writes a character message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pcMessagePattern	CHARACTER
	A character message to write to the log file
pcMessageParam1	CHARACTER
	A character message parameter to substitute &1
pcMessageParam2	CHARACTER
	A character message parameter to substitute &2
pcMessageParam3	CHARACTER
	A character message parameter to substitute &2
pcMessageParam4	CHARACTER
	A character message parameter to substitute &2
pcMessageParam5	CHARACTER
	A character message parameter to substitute &2
pcMessageParam6	CHARACTER
	A character message parameter to substitute &2
pcMessageParam7	CHARACTER
	A character message parameter to substitute &2
pcMessageParam8	CHARACTER
	A character message parameter to substitute &2
pcMessageParam9	CHARACTER
	A character message parameter to substitute &2

Top

PUBLIC WriteFormattedMessage (character, character, character, character, character, character, character, character, character, character, MessageSubSystem)

Purpose:	Writes a character message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pcMessagePattern	CHARACTER
	A character message to write to the log file
pcMessageParam1	CHARACTER
	A character message parameter to substitute &1
pcMessageParam2	CHARACTER
	A character message parameter to substitute &2
pcMessageParam3	CHARACTER
	A character message parameter to substitute &2
pcMessageParam4	CHARACTER
	A character message parameter to substitute &2
pcMessageParam5	CHARACTER
	A character message parameter to substitute &2
pcMessageParam6	CHARACTER
	A character message parameter to substitute &2
pcMessageParam7	CHARACTER
	A character message parameter to substitute &2
pcMessageParam8	CHARACTER
	A character message parameter to substitute &2
pcMessageParam9	CHARACTER
	A character message parameter to substitute &2
poMessageSubSystem	Consultingwerk.Util.MessageSubSystem
	The MessageSubSystem of the custom log entry type for the message

Top

PUBLIC WriteFormattedMessage (character, character, character, character, character, character, character, character, character, MessageSubSystem)

Purpose:	Writes a character message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pcMessagePattern	CHARACTER
	A character message to write to the log file
pcMessageParam1	CHARACTER
	A character message parameter to substitute &1
pcMessageParam2	CHARACTER
	A character message parameter to substitute &2
pcMessageParam3	CHARACTER
	A character message parameter to substitute &3
pcMessageParam4	CHARACTER
	A character message parameter to substitute &4
pcMessageParam5	CHARACTER
	A character message parameter to substitute &5
pcMessageParam6	CHARACTER
	A character message parameter to substitute &6
pcMessageParam7	CHARACTER
	A character message parameter to substitute &7
pcMessageParam8	CHARACTER
	A character message parameter to substitute &8
poMessageSubSystem	Consultingwerk.Util.MessageSubSystem
	The MessageSubSystem of the custom log entry type for the message

Top

PUBLIC WriteFormattedMessage (character, character, character, character, character, character, character, character, MessageSubSystem)

Purpose:	Writes a character message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pcMessagePattern	CHARACTER
	A character message to write to the log file
pcMessageParam1	CHARACTER
	A character message parameter to substitute &1
pcMessageParam2	CHARACTER
	A character message parameter to substitute &2
pcMessageParam3	CHARACTER
	A character message parameter to substitute &3
pcMessageParam4	CHARACTER
	A character message parameter to substitute &4
pcMessageParam5	CHARACTER
	A character message parameter to substitute &5
pcMessageParam6	CHARACTER
	A character message parameter to substitute &6
pcMessageParam7	CHARACTER
	A character message parameter to substitute &7
poMessageSubSystem	Consultingwerk.Util.MessageSubSystem
	The MessageSubSystem of the custom log entry type for the message

Top

PUBLIC WriteFormattedMessage (character, character, character, character, character, character, character, MessageSubSystem)

Purpose:	Writes a character message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pcMessagePattern	CHARACTER
	A character message to write to the log file
pcMessageParam1	CHARACTER
	A character message parameter to substitute &1
pcMessageParam2	CHARACTER
	A character message parameter to substitute &2
pcMessageParam3	CHARACTER
	A character message parameter to substitute &3
pcMessageParam4	CHARACTER
	A character message parameter to substitute &4
pcMessageParam5	CHARACTER
	A character message parameter to substitute &5
pcMessageParam6	CHARACTER
	A character message parameter to substitute &6
poMessageSubSystem	Consultingwerk.Util.MessageSubSystem
	The MessageSubSystem of the custom log entry type for the message

Top

PUBLIC WriteFormattedMessage (character, character, character, character, character, character, MessageSubSystem)

Purpose:	Writes a character message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pcMessagePattern	CHARACTER
	A character message to write to the log file
pcMessageParam1	CHARACTER
	A character message parameter to substitute &1
pcMessageParam2	CHARACTER
	A character message parameter to substitute &2
pcMessageParam3	CHARACTER
	A character message parameter to substitute &3
pcMessageParam4	CHARACTER
	A character message parameter to substitute &4
pcMessageParam5	CHARACTER
	A character message parameter to substitute &5
poMessageSubSystem	Consultingwerk.Util.MessageSubSystem
	The MessageSubSystem of the custom log entry type for the message

Top

PUBLIC WriteFormattedMessage (character, character, character, character, character, MessageSubSystem)

Purpose:	Writes a character message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pcMessagePattern	CHARACTER
	A character message to write to the log file
pcMessageParam1	CHARACTER
	A character message parameter to substitute &1
pcMessageParam2	CHARACTER
	A character message parameter to substitute &2
pcMessageParam3	CHARACTER
	A character message parameter to substitute &3
pcMessageParam4	CHARACTER
	A character message parameter to substitute &4
poMessageSubSystem	Consultingwerk.Util.MessageSubSystem
	The MessageSubSystem of the custom log entry type for the message

Top

PUBLIC WriteFormattedMessage (character, character, character, character, MessageSubSystem)

Purpose:	Writes a character message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pcMessagePattern	CHARACTER
	A character message to write to the log file
pcMessageParam1	CHARACTER
	A character message parameter to substitute &1
pcMessageParam2	CHARACTER
	A character message parameter to substitute &2
pcMessageParam3	CHARACTER
	A character message parameter to substitute &3
poMessageSubSystem	Consultingwerk.Util.MessageSubSystem
	The MessageSubSystem of the custom log entry type for the message

Top

PUBLIC WriteFormattedMessage (character, character, character, MessageSubSystem)

Purpose:	Writes a character message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pcMessagePattern	CHARACTER
	A character message to write to the log file
pcMessageParam1	CHARACTER
	A character message parameter to substitute &1
pcMessageParam2	CHARACTER
	A character message parameter to substitute &2
poMessageSubSystem	Consultingwerk.Util.MessageSubSystem
	The MessageSubSystem of the custom log entry type for the message

Top

PUBLIC WriteFormattedMessage (character, character, MessageSubSystem)

Purpose:	Writes a character message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pcMessagePattern	CHARACTER
	A character message to write to the log file
pcMessageParam	CHARACTER
	A character message parameter to substitute &1
poMessageSubSystem	Consultingwerk.Util.MessageSubSystem
	The MessageSubSystem of the custom log entry type for the message

Top

PUBLIC WriteFormattedMessage (character, date)

Purpose:	Writes a character message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pcMessagePattern	CHARACTER
	A character message to write to the log file
pdtMessageParam	DATE
	A date message parameter to substitute &1

Top

PUBLIC WriteFormattedMessage (character, date, MessageSubSystem)

Purpose:	Writes a character message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pcMessagePattern	CHARACTER
	A character message to write to the log file
pdtMessageParam	DATE
	A date message parameter to substitute &1
poMessageSubSystem	Consultingwerk.Util.MessageSubSystem
	The MessageSubSystem of the custom log entry type for the message

Top

PUBLIC WriteFormattedMessage (character, datetime)

Purpose:	Writes a character message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pcMessagePattern	CHARACTER
	A character message to write to the log file
pdtMessageParam	DATETIME
	A date time message parameter to substitute &1

Top

PUBLIC WriteFormattedMessage (character, datetime, MessageSubSystem)

Purpose:	Writes a character message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pcMessagePattern	CHARACTER
	A character message to write to the log file
pdtMessageParam	DATETIME
	A date time message parameter to substitute &1
poMessageSubSystem	Consultingwerk.Util.MessageSubSystem
	The MessageSubSystem of the custom log entry type for the message

Top

PUBLIC WriteFormattedMessage (character, datetime-tz)

Purpose:	Writes a character message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pcMessagePattern	CHARACTER
	A character message to write to the log file
pdtMessageParam	DATETIME-TZ
	A date time TZ message parameter to substitute &1

Top

PUBLIC WriteFormattedMessage (character, datetime-tz, MessageSubSystem)

Purpose:	Writes a character message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pcMessagePattern	CHARACTER
	A character message to write to the log file
pdtMessageParam	DATETIME-TZ
	A date time TZ message parameter to substitute &1
poMessageSubSystem	Consultingwerk.Util.MessageSubSystem
	The MessageSubSystem of the custom log entry type for the message

Top

PUBLIC WriteFormattedMessage (character, decimal)

Purpose:	Writes a character message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pcMessagePattern	CHARACTER
	A character message to write to the log file
pdeMessageParam	DECIMAL
	A decimal message parameter to substitute &1

Top

PUBLIC WriteFormattedMessage (character, decimal, MessageSubSystem)

Purpose:	Writes a character message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pcMessagePattern	CHARACTER
	A character message to write to the log file
pdeMessageParam	DECIMAL
	A decimal message parameter to substitute &1
poMessageSubSystem	Consultingwerk.Util.MessageSubSystem
	The MessageSubSystem of the custom log entry type for the message

Top

PUBLIC WriteFormattedMessage (character, int64)

Purpose:	Writes a character message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pcMessagePattern	CHARACTER
	A character message to write to the log file
piMessageParam	INT64
	An int64 message parameter to substitute &1

Top

PUBLIC WriteFormattedMessage (character, int64, MessageSubSystem)

Purpose:	Writes a character message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pcMessagePattern	CHARACTER
	A character message to write to the log file
piMessageParam	INT64
	An int64 message parameter to substitute &1
poMessageSubSystem	Consultingwerk.Util.MessageSubSystem
	The MessageSubSystem of the custom log entry type for the message

Top

PUBLIC WriteFormattedMessage (character, integer)

Purpose:	Writes a character message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pcMessagePattern	CHARACTER
	A character message to write to the log file
piMessageParam	INTEGER
	An integer message parameter to substitute &1

Top

PUBLIC WriteFormattedMessage (character, integer, MessageSubSystem)

Purpose:	Writes a character message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pcMessagePattern	CHARACTER
	A character message to write to the log file
piMessageParam	INTEGER
	An integer message parameter to substitute &1
poMessageSubSystem	Consultingwerk.Util.MessageSubSystem
	The MessageSubSystem of the custom log entry type for the message

Top

PUBLIC WriteFormattedMessage (character, logical)

Purpose:	Writes a character message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pcMessagePattern	CHARACTER
	A character message to write to the log file
plMessageParam	LOGICAL
	An int64 message parameter to substitute &1

Top

PUBLIC WriteFormattedMessage (character, logical, MessageSubSystem)

Purpose:	Writes a character message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pcMessagePattern	CHARACTER
	A character message to write to the log file
plMessageParam	LOGICAL
	An int64 message parameter to substitute &1
poMessageSubSystem	Consultingwerk.Util.MessageSubSystem
	The MessageSubSystem of the custom log entry type for the message

Top

PUBLIC WriteFormattedMessage (character, recid)

Purpose:	Writes a character message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pcMessagePattern	CHARACTER
	A character message to write to the log file
preMessageParam	RECID
	A recid message parameter to substitute &1

Top

PUBLIC WriteFormattedMessage (character, recid, MessageSubSystem)

Purpose:	Writes a character message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pcMessagePattern	CHARACTER
	A character message to write to the log file
preMessageParam	RECID
	A recid message parameter to substitute &1
poMessageSubSystem	Consultingwerk.Util.MessageSubSystem
	The MessageSubSystem of the custom log entry type for the message

Top

PUBLIC WriteFormattedMessage (character, rowid)

Purpose:	Writes a character message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pcMessagePattern	CHARACTER
	A character message to write to the log file
proMessageParam	ROWID
	A rowid message parameter to substitute &1

Top

PUBLIC WriteFormattedMessage (character, rowid, MessageSubSystem)

Purpose:	Writes a character message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pcMessagePattern	CHARACTER
	A character message to write to the log file
proMessageParam	ROWID
	A rowid message parameter to substitute &1
poMessageSubSystem	Consultingwerk.Util.MessageSubSystem
	The MessageSubSystem of the custom log entry type for the message

Top

PUBLIC WriteIgnoredError (Error)

Purpose:	Performs logging for an ignored error (catched but not shown)
Notes:	Requires the IgnoredErrors custom log entry type

Parameters:
poError	Progress.Lang.Error
	The error instance to log

Top

PUBLIC LONGCHAR WriteJson ()

Inherited from Consultingwerk.JsonSerializable

Purpose:	Returns a LONGCHAR representation of the state of the class instance
Notes:	Returns the classname together with the Json serialization
	This method is a facade to the JsonSerializable:Serialize method

Returns	LONGCHAR
	The LONGCHAR representation of the ISerializable objects data

Top

PUBLIC WriteJson (JsonConstruct)

Purpose:	Writes the JSON Construct to the log file
Notes:

Parameters:
poJson	Progress.Json.ObjectModel.JsonConstruct
	The JsonConstruct to log

Top

PUBLIC WriteJson (JsonConstruct, character)

Purpose:	Writes the JSON Construct to the log file
Notes:

Parameters:
poJson	Progress.Json.ObjectModel.JsonConstruct
	The JsonConstruct to log
pcMessageSubSys	CHARACTER
	The message sub system to write the JSON to

Top

PUBLIC WriteJson (JsonConstruct, MessageSubSystem)

Purpose:	Writes the JSON Construct to the log file
Notes:

Parameters:
poJson	Progress.Json.ObjectModel.JsonConstruct
	The JsonConstruct to log
poMessageSubSystem	Consultingwerk.Util.MessageSubSystem
	The MessageSubSystem of the custom log entry type for the message

Top

PUBLIC WriteMessage (character)

Purpose:	Writes a character message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pcMessage	CHARACTER
	A character message to write to the log file

Top

PUBLIC WriteMessage (character, character)

Purpose:	Writes a message to the client logfiles
Notes:	The second character parameter allows to specify that this message
	should only appear in the client logfile when a certain custom
	log entry type (CustomLogEntries) is activated.

Parameters:
pcMessage	CHARACTER
	The message text
pcMessageSubSys	CHARACTER
	The custom log entry type for the message

Top

PUBLIC WriteMessage (character, MessageSubSystem)

Purpose:	Writes a message to the client logfiles
Notes:	The second character parameter allows to specify that this message
	should only appear in the client logfile when a certain custom
	log entry type (CustomLogEntries) is activated.

Parameters:
pcMessage	CHARACTER
	The message text
poMessageSubSystem	Consultingwerk.Util.MessageSubSystem
	The MessageSubSystem of the custom log entry type for the message

Top

PUBLIC WriteMessage (date)

Purpose:	Writes an date message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pdaMessage	DATE
	A date message to write to the log file

Top

PUBLIC WriteMessage (datetime)

Purpose:	Writes an datetime message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pdaMessage	DATETIME
	A datetime message to write to the log file

Top

PUBLIC WriteMessage (decimal)

Purpose:	Writes an decimal message to the client logile and the default
	logging sub system.
Notes:

Parameters:
pdeMessage	DECIMAL
	A decimal message to write to the log file

Top

PUBLIC WriteMessage (integer)

Purpose:	Writes an integer message to the client logile and the default
	logging sub system.
Notes:

Parameters:
piMessage	INTEGER
	A integer message to write to the log file

Top

PUBLIC WriteMessage (logical)

Purpose:	Writes an logical message to the client logile and the default
	logging sub system.
Notes:

Parameters:
plMessage	LOGICAL
	A logical message to write to the log file

Top

PUBLIC WriteObjectProperties (Object, character)

Purpose:	Writes the properties of a class based object to the open logfile
Notes:	Returns silently when no logfile is open

Parameters:
poObject	Progress.Lang.Object
	The reference of the object to write
pcTitle	CHARACTER
	The title used as a prefix of the logfile output

Top

PUBLIC WritePropath ()

Purpose:	Writes the current PROPATH in a tabular fashion to the log file
Notes:	ABL stores the PROPATH as a comma-separated list of directories.
	(ABL strips the operating-specific separation characters (a colon
	( : ) on UNIX; a semicolon ( ; ) in Windows) and replaces them with
	commas.

Top

PUBLIC WriteSeparator ()

Purpose:	Writes a line full of ------------- into the current logfile
Notes:

Top

PUBLIC WriteStackTrace ()

Purpose:	Writes the current stack trace to the log file
Notes:

Top

PUBLIC WriteWidgetChain (handle)

Purpose:	Dumps all widgets in the given SESSION:FIRST-... chain to
	the logfile
Notes:	Loops from the given SESSION:FIRST-... object reference by
	the NEXT-SIBLING property

Parameters:
phFirstWidget	HANDLE
	The handle of the FIRST- widget reference

Top

PUBLIC WriteWidgetProperties (handle)

Purpose:	Writes the properties of a widget handle to the open logfile
Notes:	Returns silently when no logfile is open

Parameters:
phWidget	HANDLE
	The handle of the widget

Top

PUBLIC WriteWidgetProperties (handle, character)

Purpose:	Writes the properties of a widget handle to the open logfile
Notes:	Returns silently when no logfile is open

Parameters:
phWidget	HANDLE
	The handle of the widget
pcTitle	CHARACTER
	The title used as a prefix of the logfile output

Top

PUBLIC LONGCHAR WriteXml ()

Inherited from Consultingwerk.JsonSerializable

Purpose:	Returns an XML LONGCHAR representation of the object instance
Notes:

Returns	LONGCHAR
	The LONGCHAR representation of the ISerializable objects data

Top

PUBLIC HANDLE XmlSerialize (handle)

Inherited from Consultingwerk.JsonSerializable

Purpose:	Serializes the properties of the current object instance to
	an existing X-NODEREF object
Notes:

Parameters:
phParent	HANDLE
	The reference to the parent XML Node or Document
Returns	HANDLE
	The X-NODEREF with the properties of the serialized object

Top

PUBLIC XmlSerializeProperties (handle)

Inherited from Consultingwerk.JsonSerializable

Purpose:	Serializes the properties of this object instance as child nodes of
	the given node
Notes:

Parameters:
phObjectNode	HANDLE
	The reference to the X-NODEREF object that represents the node for the current instance

Top

PROTECTED XmlSerializeProperty (handle, character, character)

Inherited from Consultingwerk.JsonSerializable

Purpose:	Serializes a single property value to the current parent XmlNode
Notes:	Allows to override the handling of individual properties during the
	XmlSerialization

Parameters:
phParentNode	HANDLE
	The reference to the parent XML Node
pcProperty	CHARACTER
	The name of the property in the JsonObject
pcType	CHARACTER
	The type of the property

Constructor Detail

Top

PUBLIC SerializableLongcharLoggingStream ()

Purpose:	Constructor for the SerializableLongcharLoggingStream class
Notes:

Property Detail

Top

PUBLIC CHARACTER CustomLogEntries

Returns	CHARACTER

Top

PROTECTED LONGCHAR Data

Returns	LONGCHAR

Top

PUBLIC Consultingwerk.IJsonDateTypeFormatter JsonDateTypeFormatter

Inherited from Consultingwerk.JsonSerializable

Returns	Consultingwerk.IJsonDateTypeFormatter

Top

PUBLIC LOGICAL SerializeEmptyLists

Inherited from Consultingwerk.JsonSerializable

Returns	LOGICAL

Top

PUBLIC LOGICAL SerializeNullValues

Inherited from Consultingwerk.JsonSerializable

Returns	LOGICAL

Top

PUBLIC LOGICAL UseSerializedTypeInformation

Inherited from Consultingwerk.JsonSerializable

Returns	LOGICAL

info@consultingwerk.de http://www.consultingwerk.de 08.08.2019 23:57:35