Library: enhLogClassLite

VSID.enhLogClassLite

Carrier for the EnhancedLog class.
	Copyright &copy; 2002 - 2052, Devin S. Olson
	http://www.azlighthouse.com
 
	Author: Devin S. Olson (devin.olson@azlighthouse.com)
	http://www.devinolson.net
	
	Last updated: 07/2023

' ************************************************************************************
	' * Copyright 2002 Devin S. Olson
	' * 
	' * Licensed under the Apache License, Version 2.0 (the "License"); 
	' * you may not use this file except in compliance with the License. 
	' * You may obtain a copy of the License at 
	' * 
	' * http://www.apache.org/licenses/LICENSE-2.0 
	' * 	
	' * Unless required by applicable law or agreed to in writing, software 
	' * distributed under the License is distributed on an "AS IS" BASIS, 
	' * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
	' * See the License for the specific language governing permissions and 
	' * limitations under the License. 
	' * 	
 	' ************************************************************************************
 	' ************************************************************************************
	' BEGIN NOTICE	
	' *	NOTICE
	' *		Enhanced Log 
	' *		Copyright (c) 2002 - 2052 Devin S. Olson. All rights reserved.
	' *
	' * Developed by: Devin S. Olson
	' * azlighthouse works, llc.
	' * http://www.azlighthouse.com
	' * 
	' * Permission is hereby granted, free of charge, to any person obtaining a copy
	' * of this software and associated documentation files (the "Software"), to
	' * deal with the Software without restriction, including without limitation the
	' * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
	' * sell copies of the Software, and to permit persons to whom the Software is
	' * furnished to do so, subject to the following conditions:
	' * 
	' * 1. Redistributions of source code must retain the above copyright notice,
	' * this list of conditions and the following disclaimers.
	' * 
	' * 2. Redistributions in binary form must reproduce the above copyright
	' * notice, this list of conditions and the following disclaimers in the
	' * documentation and/or other materials provided with the distribution.
	' * 
	' * 3. Neither the names of Devin S. Olson, azlighthouse works, nor the names 
	' * of its contributors may be used to endorse or promote products derived 
	' * from this Software without specific prior written permission.
	' * 
	' * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
	' * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
	' * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
	' * CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
	' * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 
	' * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS 
	' * WITH THE SOFTWARE.
	' * 
	' * NOTICE TRANSLATION: 
	' * 	You can give away this code. 
	' * 	You can sell this code. 
	' * 	You can use this code in your programs, either to give away or to sell. 
	' * 	You can to whatever you want to do with this code, 
	' * 	AS LONG AS YOU CREDIT THE AUTHOR AND INCLUDE THE ABOVE LICENSE AND NOTICE. 
	' * 	It is very simple: don't be a jerk and claim that you wrote the code.
	' *	END NOTICE
 	' ************************************************************************************

Library Summary

Script Creator Devin Olson
Uses Library baliUtils_nlsxUI

Script Creator	Devin Olson
Uses Library	baliUtils_nlsxUI

Constants

Name	Value	Comment
`Public FORMALIAS_EVENTS`	`\|Events\|`
`Public FORMNAME_ENHANCEDLOGCONFIG`	`\|enhLogConfig\|`
`Public FORMNAME_MEMO`	`\|Memo\|`
`Public ITEMNAME_ENHLOG_HTMLVIEWRESOURCE`	`\|enhLog_HTMLviewreSource\|`
`Public ITEMNAME_ENHLOG_PROFILEMETHODCOUNT`	`\|enhLogProfileMethodCount\|`
`Public ITEMNAME_ENHLOG_PURGE_AGE`	`\|enhLogPurgeAge\|`
`Public ITEMNAME_ENHLOG_TARGET_FILEPATH`	`\|enhLogTargetFilepath\|`
`Public ITEMNAME_ENHLOG_TARGET_SERVER`	`\|enhLogTargetServer\|`
`Public ITEMNAME_ENHLOG_YN_AUTOSAVE`	`\|enhLogAutoSave\|`
`Public ITEMNAME_ENHLOG_YN_INCLUDEMETHODNAMES`	`\|enhLogIncludeMethodNames\|`
`Public ITEMNAME_ENHLOG_YN_LOCALECHO`	`\|enhLogLocalEcho\|`
`Public ITEMNAME_ENHLOG_YN_LOGACTIONS`	`\|enhLogActions\|`
`Public ITEMNAME_ENHLOG_YN_LOGENABLED`	`\|ITEMNAME_ENHLOG_YN_LOGENABLED\|`
`Public ITEMNAME_ENHLOG_YN_LOGERRORS`	`\|enhLogErrors\|`
`Public ITEMNAME_ENHLOG_YN_LOGMETHODRESULTS`	`\|enhLogMethodResults\|`
`Public ITEMNAME_ENHLOG_YN_LOGSTACKEXCEPTIONS`	`\|enhLogStackExceptions\|`
`Public ITEMNAME_ENHLOG_YN_LOGWARNINGS`	`\|enhLogWarnings\|`
`Public ITEMNAME_ENHLOG_YN_OVERWRITE`	`\|enhLogOverwriteFile\|`
`Public ITEMNAME_ENHLOG_YN_PROFILINGENABLED`	`\|enhLogEnableMethodProfiling\|`
`Public ITEMNAME_ENHLOG_YN_PURGEENABLED`	`\|enhLogEnableScheduledPurge\|`
`Public ITEMNAME_ENHLOG_YN_RESUMEONFAIL`	`\|enhLogResumeOnFail\|`
`Public LOG_DOC_MAX_SIZE`	`500000`

Types Summary

ErrorInfo	Carrier for Error Information
LogEntry	Log Entry information
ProfiledMethodElement	Information about a profiled method.
StackTraceElement	Summary information about a stack trace

Property Summaries

enhLogOutputToNotesLog (Get) As Boolean
FILEPATH_ENHANCEDLOG_FILE (Get) As String
enhLogOutputToNotesLog (Set) As Boolean

`enhLogOutputToNotesLog (Get) As Boolean`
`FILEPATH_ENHANCEDLOG_FILE (Get) As String`
`enhLogOutputToNotesLog (Set) As Boolean`

Classes Summary

EnhancedLog Wrapper for the Singleton Worker Class. Exposes all public logging methods.

EnhancedLog	Wrapper for the Singleton Worker Class. Exposes all public logging methods.

Method Summaries

`enhLogAction(prefix As String, description As String) As Boolean`
`enhLogActionWithLink(prefix As String, description As String, linkTo As Variant, linkcomment As String, HotSpotText As String) As Boolean`
`enhLogAppendAsDocLink(source As NotesDocument, fieldname As String, linkcomment As String, hotspottext As String) As Boolean`
`enhLogArchiveDocuments(server As String, filepath As String, view As String, max As Long, purge As Boolean, archived As Long, purged As Long) As Boolean`
`enhLogCreateLog(programname As String) As EnhancedLog`
`enhLogException(prefix As String, description As String) As Boolean`
`enhLogExceptionCarrier(ec As ExceptionCarrier) As Boolean`
`enhLogExceptionWithLink(prefix As String, description As String, linkTo As Variant, linkcomment As String, HotSpotText As String) As Boolean`
`enhLogExtendedContent(prefix As String, description As String, extendedcontent As String) As Boolean`
`enhLogExtendedContentWithLink(prefix As String, description As String, extendedcontent As String, linkTo As Variant, linkcomment As String, HotSpotText As String) As Boolean`
`enhLogGetCachedErrorCode() As Integer`
`enhLogGetCachedErrorExtended() As String`
`enhLogGetCachedErrorLine() As Integer`
`enhLogGetCachedErrorMessage() As String`
`enhLogGetCachedErrorMethod() As String`
`enhLogGetCachedErrorTimestamp() As String`
`enhLogGetConfigItemNames() As Variant`
`enhLogGetLatestLog() As NotesDocument`
`enhLogGetLogConfigDb() As NotesDatabase`
`enhLogGetLogConfigDoc(spawnNew As Boolean) As NotesDocument`
`enhLogGetLogConfigText(itemname As String) As String`
`enhLogGetLogConfigUNID() As String`
`enhLogGetMethodTicks(classname As String) As Double`
`enhLogGetNotesLogForm() As String`
`enhLogGetProfiledMethodsXMLstream(includeAll As Boolean) As NotesStream`
`enhLogGetProfileMethodTriggerCount(source As String) As Long`
`enhLogGetProgramName() As String`
`enhLogGetSubject() As String`
`enhLogGetTaggedMilliseconds(tag As String) As Double`
`enhLogGetTaggedTicks(tag As String) As Double`
`enhLogHasCachedError() As Boolean`
`enhLogHasEntries() As Boolean`
`enhLogHasErrors() As Boolean`
`enhLogIsLogDisabled() As Boolean`
`enhLogIsProfilingEnabled() As Boolean`
`enhLogProfileMethodFinish(classname As String, operation As String) As Double`
`enhLogProfileMethodStart(classname As String, operation As String) As Double`
`enhLogResetDbLog() As Boolean`
`enhLogStackTrace(prefix As String, description As String) As Boolean`
`enhLogTicksPerSecond() As Long`
`enhLogTicksToMilliseconds(source As Double) As Double`
`enhLogWarning(prefix As String, description As String) As Boolean`
`enhLogWarningWithLink(prefix As String, description As String, linkTo As Variant, linkcomment As String, HotSpotText As String) As Boolean`
`getEnhLog() As EnhancedLog`
`getFormPrefixForLogging(subform_prefix As String) As String`
`Save(force As Boolean, createResponse As Boolean) As Boolean`
`enhLogAllDocItems(source As NotesDocument)`
`enhLogClearCachedError()`
`enhLogCloseLog()`
`enhLogDumpContent(prefix As String, filepath As String)`
`enhLogLogMethodResult(description As String)`
`enhLogLogMethodResultWithLink(description As String, linkTo As Variant, linkComment As String, HotSpotText As String)`
`enhLogReleaseVersionBuild()`
`enhLogSetActionsIncludeMethodNames(source As Boolean)`
`enhLogSetAutoSave(source As Boolean)`
`enhLogSetCommonProperties(progname As String, localEcho As Boolean, logActions As Boolean, logMethodResults As Boolean, logErrors As Boolean, logStackExceptions As Boolean)`
`enhLogSetLocalEcho(source As Boolean)`
`enhLogSetLogActions(source As Boolean)`
`enhLogSetLogErrors(source As Boolean)`
`enhLogSetLogMethodResults(source As Boolean)`
`enhLogSetLogStackExceptions(source As Boolean)`
`enhLogSetLogWarnings(source As Boolean)`
`enhLogSetOverwriteFile(source As Boolean)`
`enhLogSetProgramName(source As String)`
`enhLogSetResumeOnLoggingFailure(source As Boolean)`
`enhLogSetSendTo(source As Variant)`
`enhLogSetSubject(source As String)`
`enhLogSetUserName(source As NotesName)`
`enhLogSetUserNameAbbrev(source As String)`

Properties Detail
- enhLogOutputToNotesLog (Get)
  Public Property Get enhLogOutputToNotesLog As Boolean
  Indicates if log activity should be recorded using the Events form in the Notes Log (log.nsf by default)
- FILEPATH_ENHANCEDLOG_FILE (Get)
  Public Property Get FILEPATH_ENHANCEDLOG_FILE As String
  Gets the Filepath for the current Enhanced Log File
- enhLogOutputToNotesLog (Set)
  Public Property Set enhLogOutputToNotesLog As Boolean
  Indicates if log activity should be recorded using the Events form in the Notes Log (log.nsf by default)

Public Property Get enhLogOutputToNotesLog As Boolean
Indicates if log activity should be recorded using the Events form in the Notes Log (log.nsf by default)

Public Property Get FILEPATH_ENHANCEDLOG_FILE As String
Gets the Filepath for the current Enhanced Log File

Public Property Set enhLogOutputToNotesLog As Boolean
Indicates if log activity should be recorded using the Events form in the Notes Log (log.nsf by default)

Methods Detail

enhLogAction

Public Function enhLogAction(prefix As String, description As String) As Boolean
Writes information about an Action to the log if LogActions is enabled.
idx	Argument	Data Type	Attributes	Comments
1	prefix	String		Prefix information
2	description	String		information to be written to the log.

enhLogActionWithLink

Public Function enhLogActionWithLink(prefix As String, description As String, linkTo As Variant, linkcomment As String, HotSpotText As String) As Boolean
Writes information about an Action to the log if LogActions is enabled. Appends a NotesLink to a NotesObject (Database, Document, or View) to the logged Action.
idx	Argument	Data Type	Attributes	Comments
1	prefix	String		Prefix information
2	description	String		information to be written to the log.
3	linkTo	Variant		Object for which to include a NotesLink in the log
4	linkcomment	String	ByVal	Comment for the link
5	HotSpotText	String	ByVal	Hot Spot Text to be displayed instead of a link icon.

enhLogAppendAsDocLink

Public Function enhLogAppendAsDocLink(source As NotesDocument, fieldname As String, linkcomment As String, hotspottext As String) As Boolean
Appends a DocLink to the log
idx	Argument	Data Type	Attributes	Comments
1	source	NotesDocument		Document to be appended
2	fieldname	String		Name of the field within which the document link should be created.
3	linkcomment	String		Comment about the link
4	hotspottext	String		Hotspot text to be displayed in place of a link icon.

enhLogArchiveDocuments

Public Function enhLogArchiveDocuments(server As String, filepath As String, view As String, max As Long, purge As Boolean, archived As Long, purged As Long) As Boolean
Archives Log documents from the current database to a specified target database.
idx	Argument	Data Type	Attributes	Comments
1	server	String		Name of the server containing the archive target database.
2	filepath	String		Filepath of the target database
3	view	String		Name of the view (in the current database) within which to find the log documents to be archived.
4	max	Long		Maximum number of documents to be archived
5	purge	Boolean		Flag indicating if documents should be deleted from this database after successfully being archived.
6	archived	Long		[OUTBOUND] Number of documents which have been archived.
7	purged	Long		[OUTBOUND] Number of documents which have been purged.

enhLogCreateLog

Public Function enhLogCreateLog(programname As String) As EnhancedLog
Spawns a new EnhancedLog object.
idx	Argument	Data Type	Attributes	Comments
1	programname	String		Name of the program for the EnhancedLog

enhLogException

Public Function enhLogException(prefix As String, description As String) As Boolean
Writes information about an Exception to the log if LogExceptions is enabled.
idx	Argument	Data Type	Attributes	Comments
1	prefix	String		Prefix information
2	description	String		information to be written to the log.

enhLogExceptionCarrier

Public Function enhLogExceptionCarrier(ec As ExceptionCarrier) As Boolean
Writes an Exception to the log (if LogErrors property is True
idx	Argument	Data Type	Attributes	Comments
1	ec	ExceptionCarrier		Carrier containing information about the exception.

enhLogExceptionWithLink

Public Function enhLogExceptionWithLink(prefix As String, description As String, linkTo As Variant, linkcomment As String, HotSpotText As String) As Boolean
Writes information about an Exception to the log if LogExceptions is enabled. Appends a NotesLink to a NotesObject (Database, Document, or View) to the logged Exception.
idx	Argument	Data Type	Attributes	Comments
1	prefix	String		Prefix information
2	description	String		information to be written to the log.
3	linkTo	Variant		Object for which to include a NotesLink in the log
4	linkcomment	String	ByVal	Comment for the link
5	HotSpotText	String	ByVal	Hot Spot Text to be displayed instead of a link icon.

enhLogExtendedContent

Public Function enhLogExtendedContent(prefix As String, description As String, extendedcontent As String) As Boolean
Writes ExtendedContent to the log if LogExtendedContents is enabled.
idx	Argument	Data Type	Attributes	Comments
1	prefix	String		Prefix information
2	description	String		information to be written to the log.
3	extendedcontent	String		Extended Content information

enhLogExtendedContentWithLink

Public Function enhLogExtendedContentWithLink(prefix As String, description As String, extendedcontent As String, linkTo As Variant, linkcomment As String, HotSpotText As String) As Boolean
Writes Extended Content information to the log if LogActions is enabled. Appends a NotesLink to a NotesObject (Database, Document, or View) to the logged Action.
idx	Argument	Data Type	Attributes	Comments
1	prefix	String		Prefix information
2	description	String		information to be written to the log.
3	extendedcontent	String		Extended Content to be written.
4	linkTo	Variant		Object for which to include a NotesLink in the log
5	linkcomment	String	ByVal	Comment for the link
6	HotSpotText	String	ByVal	Hot Spot Text to be displayed instead of a link icon.

enhLogGetCachedErrorCode
Public Function enhLogGetCachedErrorCode() As Integer
Gets the most recently cached Error Code

Public Function enhLogGetCachedErrorCode() As Integer
Gets the most recently cached Error Code

enhLogGetCachedErrorExtended
Public Function enhLogGetCachedErrorExtended() As String
Gets the most recently cached extended error information

Public Function enhLogGetCachedErrorExtended() As String
Gets the most recently cached extended error information

enhLogGetCachedErrorLine
Public Function enhLogGetCachedErrorLine() As Integer
Gets the Enhanced Log's Cached Error Line

Public Function enhLogGetCachedErrorLine() As Integer
Gets the Enhanced Log's Cached Error Line

enhLogGetCachedErrorMessage
Public Function enhLogGetCachedErrorMessage() As String
Gets the most recently cached error message.

Public Function enhLogGetCachedErrorMessage() As String
Gets the most recently cached error message.

enhLogGetCachedErrorMethod
Public Function enhLogGetCachedErrorMethod() As String
Gets the most recently cached error method.

Public Function enhLogGetCachedErrorMethod() As String
Gets the most recently cached error method.

enhLogGetCachedErrorTimestamp
Public Function enhLogGetCachedErrorTimestamp() As String
Gets the most recently cached error timestamp.

Public Function enhLogGetCachedErrorTimestamp() As String
Gets the most recently cached error timestamp.

enhLogGetConfigItemNames
Public Function enhLogGetConfigItemNames() As Variant
Gets the Enhanced Log Item Name constant strings.

Public Function enhLogGetConfigItemNames() As Variant
Gets the Enhanced Log Item Name constant strings.

enhLogGetLatestLog

Public Function enhLogGetLatestLog() As NotesDocument
Gets the latest log document.

enhLogGetLogConfigDb
Public Function enhLogGetLogConfigDb() As NotesDatabase
Gets an open instance of the Database defined in the Log Config document.

Public Function enhLogGetLogConfigDb() As NotesDatabase
Gets an open instance of the Database defined in the Log Config document.

enhLogGetLogConfigDoc

Public Function enhLogGetLogConfigDoc(spawnNew As Boolean) As NotesDocument
Get the Log configuration document, conditionally spawnd a new document.
idx	Argument	Data Type	Attributes	Comments
1	spawnNew	Boolean		Flag indicating if a new Log Config document should be spawned if an existing one is not found.

enhLogGetLogConfigText

Public Function enhLogGetLogConfigText(itemname As String) As String
Gets the text representation of the Log Config value for the specified Item name.
idx	Argument	Data Type	Attributes	Comments
1	itemname	String		Name of the NotesItem value to retrieve.

enhLogGetLogConfigUNID
Public Function enhLogGetLogConfigUNID() As String
Gets the UniversalID of the EnhancedLog Configuration document.

Public Function enhLogGetLogConfigUNID() As String
Gets the UniversalID of the EnhancedLog Configuration document.

enhLogGetMethodTicks

Public Function enhLogGetMethodTicks(classname As String) As Double
Returns the number of clock ticks for a calling methodname since last called.
idx	Argument	Data Type	Attributes	Comments
1	classname	String		Prefix for the calling methodname.

enhLogGetNotesLogForm
Public Function enhLogGetNotesLogForm() As String
ets the name of the form used for logging

Public Function enhLogGetNotesLogForm() As String
ets the name of the form used for logging

enhLogGetProfiledMethodsXMLstream

Public Function enhLogGetProfiledMethodsXMLstream(includeAll As Boolean) As NotesStream
Gets an XML stream containing information about all profiled methods.
idx	Argument	Data Type	Attributes	Comments
1	includeAll	Boolean		Flag indicating if all Profiled Method properties should be included.

enhLogGetProfileMethodTriggerCount

Public Function enhLogGetProfileMethodTriggerCount(source As String) As Long
Appends the clock ticks for a specified methodname to the global profile list.
idx	Argument	Data Type	Attributes	Comments
1	source	String		Name of Method being profiled.

enhLogGetProgramName
Public Function enhLogGetProgramName() As String
Gets the program name for the Enhaced Log

Public Function enhLogGetProgramName() As String
Gets the program name for the Enhaced Log

enhLogGetSubject
Public Function enhLogGetSubject() As String
Gets the subject for the Enhanced Mail Log

Public Function enhLogGetSubject() As String
Gets the subject for the Enhanced Mail Log

enhLogGetTaggedMilliseconds

Public Function enhLogGetTaggedMilliseconds(tag As String) As Double
Returns the number of milliseconds for a given tag since last called.
idx	Argument	Data Type	Attributes	Comments
1	tag	String		Unique string identifying the specific timer value to retrieve.

enhLogGetTaggedTicks

Public Function enhLogGetTaggedTicks(tag As String) As Double
Returns the number of clock ticks for a given tag since last called.
idx	Argument	Data Type	Attributes	Comments
1	tag	String		Unique string identifying the specific timer value to retrieve.

enhLogHasCachedError
Public Function enhLogHasCachedError() As Boolean
Indicates if the object has a Cached Error

Public Function enhLogHasCachedError() As Boolean
Indicates if the object has a Cached Error

enhLogHasEntries
Public Function enhLogHasEntries() As Boolean
Indicates if the object has entries.

Public Function enhLogHasEntries() As Boolean
Indicates if the object has entries.

enhLogHasErrors
Public Function enhLogHasErrors() As Boolean
Indicates if the object has Errors.

Public Function enhLogHasErrors() As Boolean
Indicates if the object has Errors.

enhLogIsLogDisabled
Public Function enhLogIsLogDisabled() As Boolean
Indicates if the object is Disabled.

Public Function enhLogIsLogDisabled() As Boolean
Indicates if the object is Disabled.

enhLogIsProfilingEnabled
Public Function enhLogIsProfilingEnabled() As Boolean
Indicates if Method Profiling is Enabled

Public Function enhLogIsProfilingEnabled() As Boolean
Indicates if Method Profiling is Enabled

enhLogProfileMethodFinish

Public Function enhLogProfileMethodFinish(classname As String, operation As String) As Double
Appends the clock ticks for a specified method to the global profile list.
idx	Argument	Data Type	Attributes	Comments
1	classname	String		Class for calling Method.
2	operation	String		Identifies "GET" or "SET" operation of calling properties.

enhLogProfileMethodStart

Public Function enhLogProfileMethodStart(classname As String, operation As String) As Double
Appends the clock ticks for a specified method to the global profile list.
idx	Argument	Data Type	Attributes	Comments
1	classname	String		Class for calling Method.
2	operation	String		Identifies "GET" or "SET" operation of calling properties.

enhLogResetDbLog
Public Function enhLogResetDbLog() As Boolean
Writes all pending log operations to disk and resets the log.

Public Function enhLogResetDbLog() As Boolean
Writes all pending log operations to disk and resets the log.

enhLogStackTrace

Public Function enhLogStackTrace(prefix As String, description As String) As Boolean
Writes information about an Warning to the log if LogWarnings is enabled, then writes a Stack Trace to the log.
idx	Argument	Data Type	Attributes	Comments
1	prefix	String		Prefix information
2	description	String		information to be written to the log.

enhLogTicksPerSecond
Public Function enhLogTicksPerSecond() As Long
Returns the number of Clock Ticks which occur per second.

Public Function enhLogTicksPerSecond() As Long
Returns the number of Clock Ticks which occur per second.

enhLogTicksToMilliseconds

Public Function enhLogTicksToMilliseconds(source As Double) As Double
Converts the number of Clock Ticks into Milliseconds.
idx	Argument	Data Type	Attributes	Comments
1	source	Double		Number of clock ticks to convert.

enhLogWarning

Public Function enhLogWarning(prefix As String, description As String) As Boolean
Writes information about an Warning to the log if LogWarnings is enabled.
idx	Argument	Data Type	Attributes	Comments
1	prefix	String		Prefix information
2	description	String		information to be written to the log.

enhLogWarningWithLink

Public Function enhLogWarningWithLink(prefix As String, description As String, linkTo As Variant, linkcomment As String, HotSpotText As String) As Boolean
Writes information about an Warning to the log if LogWarnings is enabled. Appends a NotesLink to a NotesObject (Database, Document, or View) to the logged Warning.
idx	Argument	Data Type	Attributes	Comments
1	prefix	String		Prefix information
2	description	String		information to be written to the log.
3	linkTo	Variant		Object for which to include a NotesLink in the log
4	linkcomment	String	ByVal	Comment for the link
5	HotSpotText	String	ByVal	Hot Spot Text to be displayed instead of a link icon.

getEnhLog

Public Function getEnhLog() As EnhancedLog
Gets the EnhancedLog object

getFormPrefixForLogging

Public Function getFormPrefixForLogging(subform_prefix As String) As String
Gets the Form Prefix for logging.
idx	Argument	Data Type	Attributes	Comments
1	subform_prefix	String		Subform prefix for logging.

Save

Public Function Save(force As Boolean, createResponse As Boolean) As Boolean
Attempts to save the current log by writing all content to disk.
idx	Argument	Data Type	Attributes	Comments
1	force	Boolean		Flag indicating if the log save should be forced in the evnet of a conflict.
2	createResponse	Boolean		Flag indicating if a conflict document should be created in the event of a save conflict.

enhLogAllDocItems

Public Sub enhLogAllDocItems(source As NotesDocument)
Logs extended content about a NotesDocument and all NotesItems it contains.
idx	Argument	Data Type	Attributes	Comments
1	source	NotesDocument		Document for which all tiem information should be logged

enhLogClearCachedError
Public Sub enhLogClearCachedError()
Clears the most recently cached error.

enhLogCloseLog
Public Sub enhLogCloseLog()
Closes the log

enhLogDumpContent

Public Sub enhLogDumpContent(prefix As String, filepath As String)
Reads content from a text file and writes it to the log as Extended Content
idx	Argument	Data Type	Attributes	Comments
1	prefix	String		Prefix in place for the log Extended Content
2	filepath	String		Filepath of the text file to write to the log.

enhLogLogMethodResult

Public Sub enhLogLogMethodResult(description As String)
Writes Method Results to the log (if LogMethodResults property is True)
idx	Argument	Data Type	Attributes	Comments
1	description	String		Text to be written to the log

enhLogLogMethodResultWithLink

Public Sub enhLogLogMethodResultWithLink(description As String, linkTo As Variant, linkComment As String, HotSpotText As String)
Writes Method Results with a link to the log (if LogMethodResults property is True)
idx	Argument	Data Type	Attributes	Comments
1	description	String		Text to be written to the log
2	linkTo	Variant		Element to be linked (NotesDatabase, NotesView, or NotesDocument)
3	linkComment	String	ByVal	Comment about the linked element
4	HotSpotText	String	ByVal	Hot Spot Text to be displaed instead of a link icon.

enhLogReleaseVersionBuild
Public Sub enhLogReleaseVersionBuild()
Writes the Enhanced Log Release, Version, and Build number to the log.

enhLogSetActionsIncludeMethodNames

Public Sub enhLogSetActionsIncludeMethodNames(source As Boolean)
Sets the ActionsIncludeMethodNames property of the Enhanced Log.
idx	Argument	Data Type	Attributes	Comments
1	source	Boolean		Flag indicating ActionsIncludeMethodNames

enhLogSetAutoSave
Public Sub enhLogSetAutoSave(source As Boolean)
Sets the AutoSave property of the Enhanced Log.

idx Argument Data Type Attributes Comments
1 source Boolean Flag indicating AutoSave

enhLogSetCommonProperties

Public Sub enhLogSetCommonProperties(progname As String, localEcho As Boolean, logActions As Boolean, logMethodResults As Boolean, logErrors As Boolean, logStackExceptions As Boolean)
Sets the Common Properties of the Enhanced Log.
idx	Argument	Data Type	Attributes	Comments
1	progname	String		Program Name for the enhanced log
2	localEcho	Boolean		Flag indicating if logged content should be locally echoed.
3	logActions	Boolean		Flag indicating if Actions should be logged
4	logMethodResults	Boolean		Flag indicating if Method Results should be logged
5	logErrors	Boolean		Flag indicating if Errors should be logged
6	logStackExceptions	Boolean		Flag indicating if Stack Exceptions should be logged

enhLogSetLocalEcho
Public Sub enhLogSetLocalEcho(source As Boolean)
Sets the LocalEcho property of the Enhanced Log.

idx Argument Data Type Attributes Comments
1 source Boolean Flag indicating LocalEcho

enhLogSetLogActions

Public Sub enhLogSetLogActions(source As Boolean)
Sets the LogActions property of the Enhanced Log.
idx	Argument	Data Type	Attributes	Comments
1	source	Boolean		Flag indicating LogActions

enhLogSetLogErrors
Public Sub enhLogSetLogErrors(source As Boolean)
Sets the LogErrors property of the Enhanced Log.

idx Argument Data Type Attributes Comments
1 source Boolean Flag indicating LogErrors

enhLogSetLogMethodResults

Public Sub enhLogSetLogMethodResults(source As Boolean)
Sets the LogMethodResults property of the Enhanced Log.
idx	Argument	Data Type	Attributes	Comments
1	source	Boolean		Flag indicating LogMethodResults

enhLogSetLogStackExceptions

Public Sub enhLogSetLogStackExceptions(source As Boolean)
Sets the LogStackExceptions property of the Enhanced Log.
idx	Argument	Data Type	Attributes	Comments
1	source	Boolean		Flag indicating LogStackExceptions

enhLogSetLogWarnings

Public Sub enhLogSetLogWarnings(source As Boolean)
Sets the LogWarnings property of the Enhanced Log.
idx	Argument	Data Type	Attributes	Comments
1	source	Boolean		Flag indicating LogWarnings

enhLogSetOverwriteFile

Public Sub enhLogSetOverwriteFile(source As Boolean)
Sets the OverwriteFile property of the Enhanced Log.
idx	Argument	Data Type	Attributes	Comments
1	source	Boolean		Flag indicating OverwriteFile

enhLogSetProgramName
Public Sub enhLogSetProgramName(source As String)
Sets the ProgramName property of the Enhanced Log.

idx Argument Data Type Attributes Comments
1 source String Program Name

enhLogSetResumeOnLoggingFailure

Public Sub enhLogSetResumeOnLoggingFailure(source As Boolean)
Sets the ResumeOnLoggingFailure property of the Enhanced Log.
idx	Argument	Data Type	Attributes	Comments
1	source	Boolean		Flag indicating ResumeOnLoggingFailure

enhLogSetSendTo
Public Sub enhLogSetSendTo(source As Variant)
Sets the SendTo property of the Enhanced Log.

idx Argument Data Type Attributes Comments
1 source Variant SendTo String Array

enhLogSetSubject
Public Sub enhLogSetSubject(source As String)
Sets the Subject property of the Enhanced Log.

idx Argument Data Type Attributes Comments
1 source String Subject for the Mail Log

enhLogSetUserName
Public Sub enhLogSetUserName(source As NotesName)
Sets the UserName property of the Enhanced Log.

idx Argument Data Type Attributes Comments
1 source NotesName User name for the log

enhLogSetUserNameAbbrev

Public Sub enhLogSetUserNameAbbrev(source As String)
Sets the UserNameAbbrev property of the Enhanced Log.
idx	Argument	Data Type	Attributes	Comments
1	source	String		Abbreviated form of the User Name

Public Sub enhLogSetAutoSave(source As Boolean)
Sets the AutoSave property of the Enhanced Log.
idx	Argument	Data Type	Attributes	Comments
1	source	Boolean		Flag indicating AutoSave

Public Sub enhLogSetLocalEcho(source As Boolean)
Sets the LocalEcho property of the Enhanced Log.
idx	Argument	Data Type	Attributes	Comments
1	source	Boolean		Flag indicating LocalEcho

Public Sub enhLogSetLogErrors(source As Boolean)
Sets the LogErrors property of the Enhanced Log.
idx	Argument	Data Type	Attributes	Comments
1	source	Boolean		Flag indicating LogErrors

Public Sub enhLogSetProgramName(source As String)
Sets the ProgramName property of the Enhanced Log.
idx	Argument	Data Type	Attributes	Comments
1	source	String		Program Name

Public Sub enhLogSetSendTo(source As Variant)
Sets the SendTo property of the Enhanced Log.
idx	Argument	Data Type	Attributes	Comments
1	source	Variant		SendTo String Array

Public Sub enhLogSetSubject(source As String)
Sets the Subject property of the Enhanced Log.
idx	Argument	Data Type	Attributes	Comments
1	source	String		Subject for the Mail Log

Public Sub enhLogSetUserName(source As NotesName)
Sets the UserName property of the Enhanced Log.
idx	Argument	Data Type	Attributes	Comments
1	source	NotesName		User name for the log

Library enhLogClassLite

VSID.enhLogClassLite

Library Summary

Constants

Types Summary

Property Summaries

Classes Summary

Method Summaries

Properties Detail

enhLogOutputToNotesLog (Get)

FILEPATH_ENHANCEDLOG_FILE (Get)

enhLogOutputToNotesLog (Set)

Methods Detail

enhLogAction

enhLogActionWithLink

enhLogAppendAsDocLink

enhLogArchiveDocuments

enhLogCreateLog

enhLogException

enhLogExceptionCarrier

enhLogExceptionWithLink

enhLogExtendedContent

enhLogExtendedContentWithLink

enhLogGetCachedErrorCode

enhLogGetCachedErrorExtended

enhLogGetCachedErrorLine

enhLogGetCachedErrorMessage

enhLogGetCachedErrorMethod

enhLogGetCachedErrorTimestamp

enhLogGetConfigItemNames

enhLogGetLatestLog

enhLogGetLogConfigDb

enhLogGetLogConfigDoc

enhLogGetLogConfigText

enhLogGetLogConfigUNID

enhLogGetMethodTicks

enhLogGetNotesLogForm

enhLogGetProfiledMethodsXMLstream

enhLogGetProfileMethodTriggerCount

enhLogGetProgramName

enhLogGetSubject

enhLogGetTaggedMilliseconds

enhLogGetTaggedTicks

enhLogHasCachedError

enhLogHasEntries

enhLogHasErrors

enhLogIsLogDisabled

enhLogIsProfilingEnabled

enhLogProfileMethodFinish

enhLogProfileMethodStart

enhLogResetDbLog

enhLogStackTrace

enhLogTicksPerSecond

enhLogTicksToMilliseconds

enhLogWarning

enhLogWarningWithLink

getEnhLog

getFormPrefixForLogging

Save

enhLogAllDocItems

enhLogClearCachedError

enhLogCloseLog

enhLogDumpContent

enhLogLogMethodResult

enhLogLogMethodResultWithLink

enhLogReleaseVersionBuild

enhLogSetActionsIncludeMethodNames

enhLogSetAutoSave

enhLogSetCommonProperties

enhLogSetLocalEcho

enhLogSetLogActions

enhLogSetLogErrors

enhLogSetLogMethodResults

enhLogSetLogStackExceptions

enhLogSetLogWarnings

enhLogSetOverwriteFile

enhLogSetProgramName

enhLogSetResumeOnLoggingFailure

enhLogSetSendTo

enhLogSetSubject