log.fatal: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Created page with "{{MacroFunction |name=log.fatal |trusted=true |version=1.5.2 |description= Writes a message to the log at the FATAL logging level. |usage= <source lang="mtmacro" line> log.fa...")
 
No edit summary
 
(3 intermediate revisions by 2 users not shown)
Line 4: Line 4:
|version=1.5.2
|version=1.5.2
|description=
|description=
Writes a message to the log at the FATAL logging level.
Writes a message to the log at the FATAL logging level. Use {{func|log.setLevel}} to set the appropriate level for the {{code|macro-logger}}.


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
log.fatal(message)
log.fatal(message)
</source>
</syntaxhighlight>
'''Parameters'''
'''Parameters'''
{{param|message|A string containing the message to be logged.}}
{{param|message|A string containing the message to be logged.}}
Line 16: Line 16:
Output a message to the {{code|macro-logger}} at the FATAL level.
Output a message to the {{code|macro-logger}} at the FATAL level.


<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: log.fatal("Well I'd say she certainly had marvelous judgement, Albert, if not particularly good taste.")]
[h: log.fatal("Well I'd say she certainly had marvelous judgement, Albert, if not particularly good taste.")]
</source>
</syntaxhighlight>
'''Returns:'''
'''Returns:'''


Empty string to calling macro.  Output is in log file.
Empty string to calling macro.  Output is in log file.
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
1975-03-15 09:19:22.846 [AWT-EventQueue-0] FATAL macro-logger - Well I'd say she certainly had marvelous judgement, Albert, if not particularly good taste.</source>
1975-03-15 09:19:22.846 [AWT-EventQueue-0] FATAL macro-logger - Well I'd say she certainly had marvelous judgement, Albert, if not particularly good taste.</syntaxhighlight>
|also=
|also=
[[log.getLoggers|log.getLoggers]] [[log.setLevel|log.setLevel]]
{{func|log.getLoggers}} {{func|log.setLevel}}


}}
}}
[[Category:Log Function]]
[[Category:Log Function]]

Latest revision as of 20:11, 15 March 2023

log.fatal() Function

 Note: This function can only be used in a Trusted Macro

Introduced in version 1.5.2
Writes a message to the log at the FATAL logging level. Use log.setLevel() to set the appropriate level for the macro-logger.

Usage

log.fatal(message)

Parameters

  • message - A string containing the message to be logged.

Example

Output a message to the macro-logger at the FATAL level.
[h: log.fatal("Well I'd say she certainly had marvelous judgement, Albert, if not particularly good taste.")]

Returns:

Empty string to calling macro. Output is in log file.

1975-03-15 09:19:22.846 [AWT-EventQueue-0] FATAL macro-logger - Well I'd say she certainly had marvelous judgement, Albert, if not particularly good taste.

See Also