log.info: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Created page with "{{MacroFunction |name=log.info |trusted=true |version=1.5.2 |description= Writes a message to the log at the INFO logging level. |usage= <source lang="mtmacro" line> log.info...")
 
No edit summary
 
(4 intermediate revisions by 3 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 INFO logging level.
Writes a message to the log file at the INFO 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.info(message)
log.info(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 INFO level.
Output a message to the {{code|macro-logger}} at the INFO level.


<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: log.info("There's no place like home.")]
[h: log.info("There's no place like home.")]
</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>
1939-08-25 09:19:22.844 [AWT-EventQueue-0] INFO  macro-logger - There's no place like home.
1939-08-25 09:19:22.844 [AWT-EventQueue-0] INFO  macro-logger - There's no place like home.
</source>
</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 23:59, 15 March 2023

log.info() Function

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

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

Usage

log.info(message)

Parameters

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

Example

Output a message to the macro-logger at the INFO level.
[h: log.info("There's no place like home.")]

Returns:

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

1939-08-25 09:19:22.844 [AWT-EventQueue-0] INFO  macro-logger - There's no place like home.

See Also