mvm_open_loggerT_mvm_open_loggerMvmOpenLoggerMvmOpenLogger (Operator)
Name
mvm_open_loggerT_mvm_open_loggerMvmOpenLoggerMvmOpenLogger — Open a logger.
Signature
Description
Opens a logging service. Logging messages can be sent to HDevGUI web clients by opening a logger with DestinationDestinationDestinationDestinationdestination = 'gui'"gui""gui""gui""gui".
LevelLevelLevelLevellevel must be one of the following: 'error', 'warn', 'info', 'debug'. Only log message above this level will be output.
DestinationDestinationDestinationDestinationdestination must generally match the pattern "protocol[:specifier]". The following destination protocols are available:
-
'gui'"gui""gui""gui""gui"
-
'console'"console""console""console""console"
-
'file:FILENAME'"file:FILENAME""file:FILENAME""file:FILENAME""file:FILENAME", where FILENAME specifies the full path to the destination log file.
-
'stdout'"stdout""stdout""stdout""stdout"
Actual logging messages can be sent using with mvm_log_linemvm_log_lineMvmLogLineMvmLogLineMvmLogLine or mvm_log_rawmvm_log_rawMvmLogRawMvmLogRawMvmLogRaw using the handle LoggerHandleLoggerHandleLoggerHandleLoggerHandleloggerHandle returned by this operator call.
Execution Information
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
This operator returns a handle. Note that the state of an instance of this handle type may be changed by specific operators even though the handle is used as an input parameter by those operators.
Parameters
DestinationDestinationDestinationDestinationdestination (input_control) string(-array) → HTupleHTupleHtuple (string / handle) (string / HHandle) (HString / HHandle) (char* / handle)
The log messages destination. Use 'gui'"gui""gui""gui""gui" to send log messages to all connected web clients.
Default value:
'gui'
"gui"
"gui"
"gui"
"gui"
List of values: 'console'"console""console""console""console", 'file:C:/TEMP/mylog.txt'"file:C:/TEMP/mylog.txt""file:C:/TEMP/mylog.txt""file:C:/TEMP/mylog.txt""file:C:/TEMP/mylog.txt", 'gui'"gui""gui""gui""gui", 'stdout'"stdout""stdout""stdout""stdout"
LevelLevelLevelLevellevel (input_control) string → HTupleHTupleHtuple (string) (string) (HString) (char*)
logging level
Default value:
'info'
"info"
"info"
"info"
"info"
List of values: 'debug'"debug""debug""debug""debug", 'error'"error""error""error""error", 'info'"info""info""info""info", 'warn'"warn""warn""warn""warn"
LoggerHandleLoggerHandleLoggerHandleLoggerHandleloggerHandle (output_control) lexicon → HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Logger handle
See also
mvm_log_linemvm_log_lineMvmLogLineMvmLogLineMvmLogLine,
mvm_log_rawmvm_log_rawMvmLogRawMvmLogRawMvmLogRaw,
mvm_close_loggermvm_close_loggerMvmCloseLoggerMvmCloseLoggerMvmCloseLogger
Module
Foundation