Difference between revisions of "Slverbosity"

From OpenEUO
Jump to: navigation, search
m (Usage Example)
m (Description)
Line 16: Line 16:
  
 
== Description ==
 
== Description ==
Set the error and warning reporting verbosity level of the library if a flag argument is specified, and returns the old flags value regardless.  Valid flags:
+
Set the error and warning reporting verbosity level of the library if a flag argument is specified, and returns the old flags value regardless.  Library initializes to 'med' verbosity.  Valid flags:
  
 
  flag  : effect
 
  flag  : effect
Line 24: Line 24:
 
  'hi'    library will raise unhandled exception upon any error
 
  'hi'    library will raise unhandled exception upon any error
  
Additionally, if error reporting is set to 'hi' and errors are logged to file, then a stack trace will be added to the logged error message.
+
Additionally, if error reporting is set to 'hi' and errors are redirected to file, then a stack trace will be added to the logged error message.
  
 
== Upon Error ==
 
== Upon Error ==

Revision as of 18:42, 1 November 2010

Calling Convention

Call

local o = sl.slverbosity([flags])

Args

flags is a string, valid values: 'off', 'lo', 'med', 'hi'

Results

o is a string, the old value of flags

Usage Example

local sl = dofile(getinstalldir()..'/lib/simplelib.lua')
local o  = sl.slverbosity('hi')
print(o)
--> 'med'

Description

Set the error and warning reporting verbosity level of the library if a flag argument is specified, and returns the old flags value regardless. Library initializes to 'med' verbosity. Valid flags:

flag  : effect
'off'   turn error recording completely off
'lo'    errors sent to file only, if redirection so allows
'med'   errors sent to file and or output window
'hi'    library will raise unhandled exception upon any error

Additionally, if error reporting is set to 'hi' and errors are redirected to file, then a stack trace will be added to the logged error message.

Upon Error

Called with wrong arguments, slverbosity records the error and fails silently.

See Also