Namespace: Consultingwerk.Util
Class 
LogManager Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object

File:LogManager
Syntax:Static methods only, protected constructor to disallow
instance creation
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sat Apr 05 19:52:55 CEST 2008
Purpose: Raised when the CustomLogEntries property is changed
Notes:



Top Method Summary
Options Name Purpose
+ AddCustomLogEntries (character) Adds a comma delimited list of custom log entries to the CustomLogEntries List
+ LOGICAL ClearLogFile () Clears the logfile.
+ INTEGER GetCustomLoggingLevel (character) Returns the currently active logging level for a certain custom logging entry
+ INTEGER GetCustomLoggingLevel (character, character) Returns the currently active logging level for a certain custom logging entry
+ INTEGER GetLoggingLevel (character) Returns the currently active logging level for a certain log entry type entry
+ LOGICAL IsCustomLogEntryTypeActive (character) Verifies if a custom log entry (optionally with logging level) is active
+ LOGICAL IsCustomLogEntryTypeActive (character, character) Verifies if a custom log entry (optionally with logging level) is active
+ LOGICAL LogFileIsOpen () Returns if currently a logfile is open.
# OnCustomLogEntriesChanged (EventArgs) Raises the CustomLogEntriesChanged
+ RemoveCustomLogEntries (character) Removes a comma delimited list of custom log entries from the CustomLogEntries List
+ SetLogEntryTypes (character) Sets the LOG-MANAGER:LOG-ENTRY-TYPES
+ SetLoggingLevel (character, integer) Sets the active logging level for a certain log file entry
+ SetLoggingLevel (character, LoggingLevelEnum) Sets the active logging level for a certain log file entry
# SplitCustomLogEntry (character, character, integer) Splits a custom log entry into the log entry and logging level portions
+ StartLogging (character, character) Starts Logging to a (new) client logfile
+ StartLogging (character, character, character) Starts Logging to a (new) client logfile
+ StartLogging (character, LogEntryTypesEnum) Starts Logging to a (new) client logfile
+ StartLogging (character, LogEntryTypesEnum, LogEntryTypesEnum) Starts Logging to a (new) client logfile
+ StartLogging (character, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum) Starts Logging to a (new) client logfile
+ StartLogging (character, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum) Starts Logging to a (new) client logfile
+ StartLogging (character, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum) Starts Logging to a (new) client logfile
+ StartLogging (character, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum) Starts Logging to a (new) client logfile
+ StartLogging (character, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum) Starts Logging to a (new) client logfile
+ StartLogging (character, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum) Starts Logging to a (new) client logfile
+ StartLogging (character, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum) Starts Logging to a (new) client logfile
+ StartLogging (character, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum) Starts Logging to a (new) client logfile
+ StartLogging (character, LogEntryTypesEnum[]) Starts Logging to a (new) client logfile
# CHARACTER SubstituteEntryType (LogEntryTypesEnum) Replaces the log entry type value of the LogEntryTypesEnum with the matching ABL log-entry-type
+ WriteAllObjectInstances () Dumps all objects in memory to the logfile
# WriteBuffer (handle, character) Dumps a buffer's fields to the current logfile.
+ WriteBuffer (handle, logical) Dumps a buffer's fields to the current logfile.
+ WriteBuffer (handle, logical, character) Dumps a buffer's fields to the current logfile.
+ WriteClassPath () Writes the current PROPATH in a tabular fashion to the log file
+ WriteDatabases () Writes database connections to the AppServer 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
+ LOGICAL WriteFormattedMessage (character, character) Writes a character message to the client logfile and the default logging sub system.
+ LOGICAL WriteFormattedMessage (character, character, character) Writes a character message to the client logfile and the default logging sub system.
+ LOGICAL WriteFormattedMessage (character, character, character, character) Writes a character message to the client logfile and the default logging sub system.
+ LOGICAL WriteFormattedMessage (character, character, character, character, character) Writes a character message to the client logfile and the default logging sub system.
+ LOGICAL WriteFormattedMessage (character, character, character, character, character, character) Writes a character message to the client logfile and the default logging sub system.
+ LOGICAL WriteFormattedMessage (character, character, character, character, character, character, character) Writes a character message to the client logfile and the default logging sub system.
+ LOGICAL WriteFormattedMessage (character, character, character, character, character, character, character, character) Writes a character message to the client logfile and the default logging sub system.
+ LOGICAL WriteFormattedMessage (character, character, character, character, character, character, character, character, character) Writes a character message to the client logfile and the default logging sub system.
+ LOGICAL WriteFormattedMessage (character, character, character, character, character, character, character, character, character, character) Writes a character message to the client logfile and the default logging sub system.
+ LOGICAL WriteFormattedMessage (character, character, character, character, character, character, character, character, character, character, MessageSubSystem) Writes a character message to the client logfile and the default logging sub system.
+ LOGICAL WriteFormattedMessage (character, character, character, character, character, character, character, character, character, MessageSubSystem) Writes a character message to the client logfile and the default logging sub system.
+ LOGICAL WriteFormattedMessage (character, character, character, character, character, character, character, character, MessageSubSystem) Writes a character message to the client logfile and the default logging sub system.
+ LOGICAL WriteFormattedMessage (character, character, character, character, character, character, character, MessageSubSystem) Writes a character message to the client logfile and the default logging sub system.
+ LOGICAL WriteFormattedMessage (character, character, character, character, character, character, MessageSubSystem) Writes a character message to the client logfile and the default logging sub system.
+ LOGICAL WriteFormattedMessage (character, character, character, character, character, MessageSubSystem) Writes a character message to the client logfile and the default logging sub system.
+ LOGICAL WriteFormattedMessage (character, character, character, character, MessageSubSystem) Writes a character message to the client logfile and the default logging sub system.
+ LOGICAL WriteFormattedMessage (character, character, character, MessageSubSystem) Writes a character message to the client logfile and the default logging sub system.
+ LOGICAL WriteFormattedMessage (character, character, MessageSubSystem) Writes a character message to the client logfile and the default logging sub system.
+ LOGICAL WriteFormattedMessage (character, date) Writes a character message to the client logfile and the default logging sub system.
+ LOGICAL WriteFormattedMessage (character, date, MessageSubSystem) Writes a character message to the client logfile and the default logging sub system.
+ LOGICAL WriteFormattedMessage (character, datetime) Writes a character message to the client logfile and the default logging sub system.
+ LOGICAL WriteFormattedMessage (character, datetime, MessageSubSystem) Writes a character message to the client logfile and the default logging sub system.
+ LOGICAL WriteFormattedMessage (character, datetime-tz) Writes a character message to the client logfile and the default logging sub system.
+ LOGICAL WriteFormattedMessage (character, datetime-tz, MessageSubSystem) Writes a character message to the client logfile and the default logging sub system.
+ LOGICAL WriteFormattedMessage (character, decimal) Writes a character message to the client logfile and the default logging sub system.
+ LOGICAL WriteFormattedMessage (character, decimal, MessageSubSystem) Writes a character message to the client logfile and the default logging sub system.
+ LOGICAL WriteFormattedMessage (character, int64) Writes a character message to the client logfile and the default logging sub system.
+ LOGICAL WriteFormattedMessage (character, int64, MessageSubSystem) Writes a character message to the client logfile and the default logging sub system.
+ LOGICAL WriteFormattedMessage (character, integer) Writes a character message to the client logfile and the default logging sub system.
+ LOGICAL WriteFormattedMessage (character, integer, MessageSubSystem) Writes a character message to the client logfile and the default logging sub system.
+ LOGICAL WriteFormattedMessage (character, logical) Writes a character message to the client logfile and the default logging sub system.
+ LOGICAL WriteFormattedMessage (character, logical, MessageSubSystem) Writes a character message to the client logfile and the default logging sub system.
+ LOGICAL WriteFormattedMessage (character, recid) Writes a character message to the client logfile and the default logging sub system.
+ LOGICAL WriteFormattedMessage (character, recid, MessageSubSystem) Writes a character message to the client logfile and the default logging sub system.
+ LOGICAL WriteFormattedMessage (character, rowid) Writes a character message to the client logfile and the default logging sub system.
+ LOGICAL WriteFormattedMessage (character, rowid, MessageSubSystem) Writes a character message to the client logfile and the default logging sub system.
+ WriteIgnoredError (Error) Performs logging for an ignored error (catched but not shown)
+ LOGICAL WriteJson (JsonConstruct) Writes the JSON Construct to the log file
+ LOGICAL WriteJson (JsonConstruct, character) Writes the JSON Construct to the log file
+ LOGICAL WriteJson (JsonConstruct, MessageSubSystem) Writes the JSON Construct to the log file
+ LOGICAL WriteMessage (character) Writes a character message to the client logfile and the default logging sub system.
+ LOGICAL WriteMessage (character, character) Writes a message to the client
+ LOGICAL WriteMessage (character, MessageSubSystem) Writes a message to the client logfile
+ LOGICAL WriteMessage (date) Writes an date message to the client logfile and the default logging sub system.
+ LOGICAL WriteMessage (datetime) Writes an datetime message to the client logfile and the default logging sub system.
+ LOGICAL WriteMessage (decimal) Writes an decimal message to the client logfile and the default logging sub system.
+ LOGICAL WriteMessage (integer) Writes an integer message to the client logfile and the default logging sub system.
+ LOGICAL WriteMessage (logical) Writes an logical message to the client logfile and the default logging sub system.
+ WriteObjectProperties (Object, character) Writes the properties of a class based object to the open logfile
# WriteObjectProperties (Object, character, integer) 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
+ WriteToServerLogfile (character) Writes a Character Message to the AppServer Logfile
+ WriteWidgetChain (handle) Dumps all widgets in the given SESSION:FIRST-... chain to the logfile
+ WriteWidgetHierarchy (handle) Writes a widget-tree to the LogFile
# WriteWidgetHierarchy (handle, integer) Writes a widget-tree to the Logfile, e.g. a MENU-Structure
+ 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

Top Constructor Summary
Options Name Purpose
LogManager () Constructor for the LogManager class
# LogManager () Protected default constructor.

Top Event Summary
Options Name Purpose
+ CustomLogEntriesChanged (EventArgs) Raised when the CustomLogEntries property is changed

Top Property Summary
Options Name Purpose
+ CHARACTER CustomLogEntries
+ CHARACTER EntryTypesList
+ Consultingwerk.Util.LoggingLevelBuilder.LoggingLevelBuilder LogEntries
+ CHARACTER LogFileName
+ CHARACTER LoggingPreset


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

PUBLIC LOGICAL ClearLogFile ()

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

Returns LOGICAL
Logical value indicating if the method was successful
Top

PUBLIC INTEGER GetCustomLoggingLevel (character)

Purpose: Returns the currently active logging level for a certain
custom logging entry
Notes:

Parameters:
pcEntry CHARACTER
The custom entry type
Returns INTEGER
The current logging level of the entry type
Top

PUBLIC INTEGER GetCustomLoggingLevel (character, character)

Purpose: Returns the currently active logging level for a certain
custom logging entry
Notes:

Parameters:
pcEntry CHARACTER
The custom entry type
pcActiveEntries CHARACTER
The list of the active custom log manager entries
Returns INTEGER
The current logging level of the entry type
Top

PUBLIC INTEGER GetLoggingLevel (character)

Purpose: Returns the currently active logging level for a certain log entry type
entry
Notes: Errors from the LOG-MANAGER will be ignored

Parameters:
pcEntry CHARACTER
The entry type
Returns INTEGER
The current logging level of the entry type
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 LOGICAL IsCustomLogEntryTypeActive (character, character)

Purpose: Verifies if a custom log entry (optionally with logging level)
is active
Notes: This variant of the method allows custom ILoggingStream implementations
to leverage the actual implementation

Parameters:
pcEntry CHARACTER
The Log Entry to validate
pcActiveEntries CHARACTER
The list of the active custom log manager entries
Returns LOGICAL
Logical value indicating if the custom log entry type is activated
Top

PUBLIC LOGICAL LogFileIsOpen ()

Purpose: Returns if currently a logfile is open.
Notes:

Returns LOGICAL
Logical value indicating if a log file is open
Top

PROTECTED OnCustomLogEntriesChanged (EventArgs)

Purpose: Raises the CustomLogEntriesChanged
Notes:

Parameters:
e Consultingwerk.EventArgs
The Consultingwerk.EventArgs with the data for the event
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 SetLogEntryTypes (character)

Purpose: Sets the LOG-MANAGER:LOG-ENTRY-TYPES
Notes: Ignores errors thrown for invalid values, values are written to
the default output for BATCH sessions or the client logfile

Parameters:
pcLogEntryTypes CHARACTER
The new value for LOG-MANAGER:LOG-ENTRY-TYPES
Top

PUBLIC SetLoggingLevel (character, integer)

Purpose: Sets the active logging level for a certain log file entry
Notes: Errors from the LOG-MANAGER will be thrown to the caller.

Parameters:
pcEntry CHARACTER
The entry type
piValue INTEGER
The new logging level of the entry type
Top

PUBLIC SetLoggingLevel (character, LoggingLevelEnum)

Purpose: Sets the active logging level for a certain log file entry
Notes: Errors from the LOG-MANAGER will be thrown to the caller.

Parameters:
pcEntry CHARACTER
The log entry type
poLoggingLevel Consultingwerk.Framework.Enum.LoggingLevelEnum
The LoggingLevelEnum to set for the log entry type
Top

PROTECTED SplitCustomLogEntry (character, character, integer)

Purpose: Splits a custom log entry into the log entry and logging level
portions
Notes: When no logging level is contained in the original entry, returns
2 as the default

Parameters:
pcEntry CHARACTER
The log entry to split into custom log entry type and logging level
pcCustomLogEntryType CHARACTER
The custom log entry type portion
piLoggingLevel INTEGER
The logging level or 2 as the default
Top

PUBLIC StartLogging (character, character)

Purpose: Starts Logging to a (new) client logfile
Notes: Sets LOG-ENTRY-TYPES and clears the logfile

Parameters:
pcLogfileName CHARACTER
The name of the Logfile to write to
pcLogentryTypes CHARACTER
The log-entry types to activate
Top

PUBLIC StartLogging (character, character, character)

Purpose: Starts Logging to a (new) client logfile
Notes: Sets LOG-ENTRY-TYPES and clears the logfile

Parameters:
pcLogfileName CHARACTER
The name of the Logfile to write to
pcLogentryTypes CHARACTER
The log-entry types to activate
pcCustomLogEntries CHARACTER
The custom log-entries to activate
Top

PUBLIC StartLogging (character, LogEntryTypesEnum)

Purpose: Starts Logging to a (new) client logfile
Notes: Sets LOG-ENTRY-TYPES and clears the logfile

Parameters:
pcLogfileName CHARACTER
The name of the Logfile to write to
poLogentryType1 Consultingwerk.Util.Enum.LogEntryTypesEnum
The first log-entry type to activate
Top

PUBLIC StartLogging (character, LogEntryTypesEnum, LogEntryTypesEnum)

Purpose: Starts Logging to a (new) client logfile
Notes: Sets LOG-ENTRY-TYPES and clears the logfile

Parameters:
pcLogfileName CHARACTER
The name of the Logfile to write to
poLogentryType1 Consultingwerk.Util.Enum.LogEntryTypesEnum
The first log-entry type to activate
poLogentryType2 Consultingwerk.Util.Enum.LogEntryTypesEnum
The second log-entry type to activate
Top

PUBLIC StartLogging (character, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum)

Purpose: Starts Logging to a (new) client logfile
Notes: Sets LOG-ENTRY-TYPES and clears the logfile

Parameters:
pcLogfileName CHARACTER
The name of the Logfile to write to
poLogentryType1 Consultingwerk.Util.Enum.LogEntryTypesEnum
The first log-entry type to activate
poLogentryType2 Consultingwerk.Util.Enum.LogEntryTypesEnum
The second log-entry type to activate
poLogentryType3 Consultingwerk.Util.Enum.LogEntryTypesEnum
The third log-entry type to activate
Top

PUBLIC StartLogging (character, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum)

Purpose: Starts Logging to a (new) client logfile
Notes: Sets LOG-ENTRY-TYPES and clears the logfile

Parameters:
pcLogfileName CHARACTER
The name of the Logfile to write to
poLogentryType1 Consultingwerk.Util.Enum.LogEntryTypesEnum
The first log-entry type to activate
poLogentryType2 Consultingwerk.Util.Enum.LogEntryTypesEnum
The second log-entry type to activate
poLogentryType3 Consultingwerk.Util.Enum.LogEntryTypesEnum
The third log-entry type to activate
poLogentryType4 Consultingwerk.Util.Enum.LogEntryTypesEnum
The fourth log-entry type to activate
Top

PUBLIC StartLogging (character, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum)

Purpose: Starts Logging to a (new) client logfile
Notes: Sets LOG-ENTRY-TYPES and clears the logfile

Parameters:
pcLogfileName CHARACTER
The name of the Logfile to write to
poLogentryType1 Consultingwerk.Util.Enum.LogEntryTypesEnum
The first log-entry type to activate
poLogentryType2 Consultingwerk.Util.Enum.LogEntryTypesEnum
The second log-entry type to activate
poLogentryType3 Consultingwerk.Util.Enum.LogEntryTypesEnum
The third log-entry type to activate
poLogentryType4 Consultingwerk.Util.Enum.LogEntryTypesEnum
The fourth log-entry type to activate
poLogentryType5 Consultingwerk.Util.Enum.LogEntryTypesEnum
The fifth log-entry type to activate
Top

PUBLIC StartLogging (character, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum)

Purpose: Starts Logging to a (new) client logfile
Notes: Sets LOG-ENTRY-TYPES and clears the logfile

Parameters:
pcLogfileName CHARACTER
The name of the Logfile to write to
poLogentryType1 Consultingwerk.Util.Enum.LogEntryTypesEnum
The first log-entry type to activate
poLogentryType2 Consultingwerk.Util.Enum.LogEntryTypesEnum
The second log-entry type to activate
poLogentryType3 Consultingwerk.Util.Enum.LogEntryTypesEnum
The third log-entry type to activate
poLogentryType4 Consultingwerk.Util.Enum.LogEntryTypesEnum
The fourth log-entry type to activate
poLogentryType5 Consultingwerk.Util.Enum.LogEntryTypesEnum
The fifth log-entry type to activate
poLogentryType6 Consultingwerk.Util.Enum.LogEntryTypesEnum
The sixth log-entry type to activate
Top

PUBLIC StartLogging (character, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum)

Purpose: Starts Logging to a (new) client logfile
Notes: Sets LOG-ENTRY-TYPES and clears the logfile

Parameters:
pcLogfileName CHARACTER
The name of the Logfile to write to
poLogentryType1 Consultingwerk.Util.Enum.LogEntryTypesEnum
The first log-entry type to activate
poLogentryType2 Consultingwerk.Util.Enum.LogEntryTypesEnum
The second log-entry type to activate
poLogentryType3 Consultingwerk.Util.Enum.LogEntryTypesEnum
The third log-entry type to activate
poLogentryType4 Consultingwerk.Util.Enum.LogEntryTypesEnum
The fourth log-entry type to activate
poLogentryType5 Consultingwerk.Util.Enum.LogEntryTypesEnum
The fifth log-entry type to activate
poLogentryType6 Consultingwerk.Util.Enum.LogEntryTypesEnum
The sixth log-entry type to activate
poLogentryType7 Consultingwerk.Util.Enum.LogEntryTypesEnum
The seventh log-entry type to activate
Top

PUBLIC StartLogging (character, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum)

Purpose: Starts Logging to a (new) client logfile
Notes: Sets LOG-ENTRY-TYPES and clears the logfile

Parameters:
pcLogfileName CHARACTER
The name of the Logfile to write to
poLogentryType1 Consultingwerk.Util.Enum.LogEntryTypesEnum
The first log-entry type to activate
poLogentryType2 Consultingwerk.Util.Enum.LogEntryTypesEnum
The second log-entry type to activate
poLogentryType3 Consultingwerk.Util.Enum.LogEntryTypesEnum
The third log-entry type to activate
poLogentryType4 Consultingwerk.Util.Enum.LogEntryTypesEnum
The fourth log-entry type to activate
poLogentryType5 Consultingwerk.Util.Enum.LogEntryTypesEnum
The fifth log-entry type to activate
poLogentryType6 Consultingwerk.Util.Enum.LogEntryTypesEnum
The sixth log-entry type to activate
poLogentryType7 Consultingwerk.Util.Enum.LogEntryTypesEnum
The seventh log-entry type to activate
poLogentryType8 Consultingwerk.Util.Enum.LogEntryTypesEnum
The eighth log-entry type to activate
Top

PUBLIC StartLogging (character, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum)

Purpose: Starts Logging to a (new) client logfile
Notes: Sets LOG-ENTRY-TYPES and clears the logfile

Parameters:
pcLogfileName CHARACTER
The name of the Logfile to write to
poLogentryType1 Consultingwerk.Util.Enum.LogEntryTypesEnum
The first log-entry type to activate
poLogentryType2 Consultingwerk.Util.Enum.LogEntryTypesEnum
The second log-entry type to activate
poLogentryType3 Consultingwerk.Util.Enum.LogEntryTypesEnum
The third log-entry type to activate
poLogentryType4 Consultingwerk.Util.Enum.LogEntryTypesEnum
The fourth log-entry type to activate
poLogentryType5 Consultingwerk.Util.Enum.LogEntryTypesEnum
The fifth log-entry type to activate
poLogentryType6 Consultingwerk.Util.Enum.LogEntryTypesEnum
The sixth log-entry type to activate
poLogentryType7 Consultingwerk.Util.Enum.LogEntryTypesEnum
The seventh log-entry type to activate
poLogentryType8 Consultingwerk.Util.Enum.LogEntryTypesEnum
The eighth log-entry type to activate
poLogentryType9 Consultingwerk.Util.Enum.LogEntryTypesEnum
The ninth log-entry type to activate
Top

PUBLIC StartLogging (character, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum, LogEntryTypesEnum)

Purpose: Starts Logging to a (new) client logfile
Notes: Sets LOG-ENTRY-TYPES and clears the logfile

Parameters:
pcLogfileName CHARACTER
The name of the Logfile to write to
poLogentryType1 Consultingwerk.Util.Enum.LogEntryTypesEnum
The first log-entry type to activate
poLogentryType2 Consultingwerk.Util.Enum.LogEntryTypesEnum
The second log-entry type to activate
poLogentryType3 Consultingwerk.Util.Enum.LogEntryTypesEnum
The third log-entry type to activate
poLogentryType4 Consultingwerk.Util.Enum.LogEntryTypesEnum
The fourth log-entry type to activate
poLogentryType5 Consultingwerk.Util.Enum.LogEntryTypesEnum
The fifth log-entry type to activate
poLogentryType6 Consultingwerk.Util.Enum.LogEntryTypesEnum
The sixth log-entry type to activate
poLogentryType7 Consultingwerk.Util.Enum.LogEntryTypesEnum
The seventh log-entry type to activate
poLogentryType8 Consultingwerk.Util.Enum.LogEntryTypesEnum
The eighth log-entry type to activate
poLogentryType9 Consultingwerk.Util.Enum.LogEntryTypesEnum
The ninth log-entry type to activate
poLogentryType10 Consultingwerk.Util.Enum.LogEntryTypesEnum
The tenth log-entry type to activate
Top

PUBLIC StartLogging (character, LogEntryTypesEnum[])

Purpose: Starts Logging to a (new) client logfile
Notes: Sets LOG-ENTRY-TYPES and clears the logfile

Parameters:
pcLogfileName CHARACTER
The name of the Logfile to write to
poLogentryTypes Consultingwerk.Util.Enum.LogEntryTypesEnum
The array of log-entry types to activate
Top

PROTECTED CHARACTER SubstituteEntryType (LogEntryTypesEnum)

Purpose: Replaces the log entry type value of the LogEntryTypesEnum with the
matching ABL log-entry-type
Notes:

Parameters:
poEntryType Consultingwerk.Util.Enum.LogEntryTypesEnum
The LogEntryTypesEnum value
Returns CHARACTER
The log-entry-type matching with LogEntryTypesEnum
Top

PUBLIC WriteAllObjectInstances ()

Purpose: Dumps all objects in memory to the logfile
Notes: Loops from SESSION:FIRST-OBJECT by Next-Sibling

Top

PROTECTED WriteBuffer (handle, character)

Purpose: Dumps a buffer's fields to the current logfile.
Notes: When no record is available in that buffer, a "no record is available"
message is written instead.

Parameters:
phBuffer HANDLE
The handle to the buffer
pcExcludeFields CHARACTER
Comma delimited list of field names to exclude
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 TRUE, the method will create an additional buffer for the table and run a FIND-FIRST on that buffer to not change the original buffer's position
Top

PUBLIC WriteBuffer (handle, logical, character)

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

Parameters:
phBuffer HANDLE
The handle to the buffer
plFindFirst LOGICAL
When plFindFirst is TRUE, the method will create an additional buffer for the table and run a FIND-FIRST on that buffer to not change the original buffer's position
pcExcludeFields CHARACTER
Comma delimited list of field names to exclude
Top

PUBLIC WriteClassPath ()

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 WriteDatabases ()

Purpose: Writes database connections to the AppServer logfile
Notes:

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 LOGICAL WriteFormattedMessage (character, character)

Purpose: Writes a character message to the client logfile 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

PUBLIC LOGICAL WriteFormattedMessage (character, character, character)

Purpose: Writes a character message to the client logfile 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

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

Purpose: Writes a character message to the client logfile 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

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

Purpose: Writes a character message to the client logfile 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

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

Purpose: Writes a character message to the client logfile 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

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

Purpose: Writes a character message to the client logfile 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

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

Purpose: Writes a character message to the client logfile 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

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

Purpose: Writes a character message to the client logfile 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

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

Purpose: Writes a character message to the client logfile 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

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

Purpose: Writes a character message to the client logfile 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

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

Purpose: Writes a character message to the client logfile 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

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

Purpose: Writes a character message to the client logfile 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

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

Purpose: Writes a character message to the client logfile 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

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

Purpose: Writes a character message to the client logfile 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

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

Purpose: Writes a character message to the client logfile 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

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

Purpose: Writes a character message to the client logfile 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

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

Purpose: Writes a character message to the client logfile 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

PUBLIC LOGICAL WriteFormattedMessage (character, character, MessageSubSystem)

Purpose: Writes a character message to the client logfile 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

PUBLIC LOGICAL WriteFormattedMessage (character, date)

Purpose: Writes a character message to the client logfile 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

PUBLIC LOGICAL WriteFormattedMessage (character, date, MessageSubSystem)

Purpose: Writes a character message to the client logfile 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

PUBLIC LOGICAL WriteFormattedMessage (character, datetime)

Purpose: Writes a character message to the client logfile 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

PUBLIC LOGICAL WriteFormattedMessage (character, datetime, MessageSubSystem)

Purpose: Writes a character message to the client logfile 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

PUBLIC LOGICAL WriteFormattedMessage (character, datetime-tz)

Purpose: Writes a character message to the client logfile 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

PUBLIC LOGICAL WriteFormattedMessage (character, datetime-tz, MessageSubSystem)

Purpose: Writes a character message to the client logfile 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

PUBLIC LOGICAL WriteFormattedMessage (character, decimal)

Purpose: Writes a character message to the client logfile 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

PUBLIC LOGICAL WriteFormattedMessage (character, decimal, MessageSubSystem)

Purpose: Writes a character message to the client logfile 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

PUBLIC LOGICAL WriteFormattedMessage (character, int64)

Purpose: Writes a character message to the client logfile 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

PUBLIC LOGICAL WriteFormattedMessage (character, int64, MessageSubSystem)

Purpose: Writes a character message to the client logfile 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

PUBLIC LOGICAL WriteFormattedMessage (character, integer)

Purpose: Writes a character message to the client logfile 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

PUBLIC LOGICAL WriteFormattedMessage (character, integer, MessageSubSystem)

Purpose: Writes a character message to the client logfile 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

PUBLIC LOGICAL WriteFormattedMessage (character, logical)

Purpose: Writes a character message to the client logfile 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

PUBLIC LOGICAL WriteFormattedMessage (character, logical, MessageSubSystem)

Purpose: Writes a character message to the client logfile 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

PUBLIC LOGICAL WriteFormattedMessage (character, recid)

Purpose: Writes a character message to the client logfile 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

PUBLIC LOGICAL WriteFormattedMessage (character, recid, MessageSubSystem)

Purpose: Writes a character message to the client logfile 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

PUBLIC LOGICAL WriteFormattedMessage (character, rowid)

Purpose: Writes a character message to the client logfile 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

PUBLIC LOGICAL WriteFormattedMessage (character, rowid, MessageSubSystem)

Purpose: Writes a character message to the client logfile 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
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 LOGICAL WriteJson (JsonConstruct)

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

Parameters:
poJson Progress.Json.ObjectModel.JsonConstruct
The JsonConstruct to log
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

PUBLIC LOGICAL 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

PUBLIC LOGICAL 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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

PUBLIC LOGICAL WriteMessage (character)

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

Parameters:
pcMessage CHARACTER
A character message to write to the log file
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

PUBLIC LOGICAL WriteMessage (character, character)

Purpose: Writes a message to the client
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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

PUBLIC LOGICAL WriteMessage (character, MessageSubSystem)

Purpose: Writes a message to the client logfile
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
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

PUBLIC LOGICAL WriteMessage (date)

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

Parameters:
pdaMessage DATE
A date message to write to the log file
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

PUBLIC LOGICAL WriteMessage (datetime)

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

Parameters:
pdaMessage DATETIME
A datetime message to write to the log file
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

PUBLIC LOGICAL WriteMessage (decimal)

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

Parameters:
pdeMessage DECIMAL
A decimal message to write to the log file
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

PUBLIC LOGICAL WriteMessage (integer)

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

Parameters:
piMessage INTEGER
A integer message to write to the log file
Returns LOGICAL
Logical value indicating if the message has been written to the log file
Top

PUBLIC LOGICAL WriteMessage (logical)

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

Parameters:
plMessage LOGICAL
A logical message to write to the log file
Returns LOGICAL
Logical value indicating if the message has been written 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

PROTECTED WriteObjectProperties (Object, character, integer)

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
piIndent INTEGER
Number of characters to indent the output for recursive calls
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 WriteToServerLogfile (character)

Purpose: Writes a Character Message to the AppServer Logfile
Notes: Invokable from the client, only supported from OpenEdge 11 on

Parameters:
pcMessage CHARACTER
The Message to write to the AppServer Logfile
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 WriteWidgetHierarchy (handle)

Purpose: Writes a widget-tree to the LogFile
Notes:

Parameters:
phParent HANDLE
The handle of the Parent Menu Item
Top

PROTECTED WriteWidgetHierarchy (handle, integer)

Purpose: Writes a widget-tree to the Logfile, e.g. a MENU-Structure
Notes: Based on iterating FIRST-CHILD and NEXT-SIBLING

Parameters:
phParent HANDLE
The handle of the Parent Menu Item
piLevel INTEGER
The current level
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


Constructor Detail
Top

STATIC LogManager ()

Purpose: Constructor for the LogManager class
Notes:

Top

PROTECTED LogManager ()

Purpose: Protected default constructor.
Notes: There's no need to create instances of the helper classes
Overridden in Consultingwerk.Dynamics.Framework.LogManager



Event Detail
Top

PUBLIC CustomLogEntriesChanged (EventArgs)

Purpose: Raised when the CustomLogEntries property is changed
Notes:

Parameters:
e Consultingwerk.EventArgs
The Consultingwerk.EventArgs with the data for the event


Property Detail
Top

PUBLIC CHARACTER CustomLogEntries


Returns CHARACTER
Top

PUBLIC CHARACTER EntryTypesList


Returns CHARACTER
Top

PUBLIC Consultingwerk.Util.LoggingLevelBuilder.LoggingLevelBuilder LogEntries


Returns Consultingwerk.Util.LoggingLevelBuilder.LoggingLevelBuilder
Top

PUBLIC CHARACTER LogFileName


Returns CHARACTER
Top

PUBLIC CHARACTER LoggingPreset


Returns CHARACTER


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       27.03.2024 00:52:06