DitsLogMsg - Write a message to the log file.

Function

Write a message to the log file.

Description

If DRAMA has an enabled logging system (see DitsSetLogSys()) then this routine calls the logLogMsg routine enabled by that logging system. The intention is to allow libraries and user code to log, without having to know what logging system is enable, if any.

Language

Call

(void) = DitsLogMsg (level, prefix, status, message,...)

Parameters

(">" input, "!" modified, "W" workspace, "<" output)

>	level	unsigned	A logging level indicator. One of the values below should be set to indicate what is being logged such that the logging system can select what is actually formated and written as desired.

`DITS_LOG_STARTUP`	Message is a startup mesage.
`DITS_LOG_INST`	Message concerns running instrumentation
`DITS_LOG_USER1`	User defined.
`DITS_LOG_USER2`	User defined.
`DITS_LOG_ALL`	Always log this message to the file.

>	prefix	char `*`	A prefix string for the message, indicating say the library concerned.
`!`	status	StatusType `*`	Modified status. (>) message The message as a C-Printf style format string. Subsequent arguments are arguments to the printf format.

Include files

DitsUtil.h

External functions used

External values used

DitsTask

Prior requirements

Can only be called from a Dits Application routine

Support

Tony Farrell, AAO

Click here for the DRAMA home page and here for the AAO home page.

For more information, contact tony.farrell@mq.edu.au