CygNet Studio > Scripting in CygNet Studio > Global Scripting Objects > LogManager Object > LogManager Methods

LogManager Methods

The LogManager methods can be used with event options in scripted CygNet Studio screens to assist with script profiling. LogManager works in conjunction with the LOGMASK.SCRIPT keyword in the HSS service configuration file. See HSS Profiling or CygNet Studio Profiling for more information.

The LogManager object contains the following methods:

GetProfiler

The GetProfiler method writes a profile message to the scripting log file. Returns an object that logs a profile timing message on creation and deletion (object goes in or out of scope). On creation PROFILE_MAX must be set and on deletion (object goes out of scope) PROFILE_MIN must be set.

Syntax

GetProfiler()

Example

Set profiler = GetProfiler()

Back to top

LogAll

The LogAll method writes the message string to the scripting log file.

Syntax

LogAll(Message As String)

Parameters

Parameter

Required

Description
Message Y Logs all messages regardless.

Example

LogAll("Test Message for LogAll method")

Back to top

LogMax

The LogMax method writes the message string to the scripting log file if MAX_TRACE is set in the HSS service configuration file.

Syntax

LogMax(Message As String)

Parameters

Parameter

Required

Description
Message Y Logs the message if MAX_TRACE is set.

Example

LogMax("Test Message for LogMax method")

Back to top

LogMin

The LogMin method writes the message string to the scripting log file if MIN_TRACE is set in the HSS service configuration file.

Syntax

LogMin(Message As String)

Parameters

Parameter

Required

Description
Message Y Logs the message if MIN_TRACE is set.

Example

LogMin("Test Message for LogMin method")

Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.