Logging

Name -- Syntax / Description
miva_closelog
miva_closelog()
Closes the connection to the log file and otherwise eliminates the effect of the last call to miva_openlog. Will cause any subsequent calls to miva_setlogmask and miva_writelog to fail until miva_openlog is called again.
Returns 1 on success, 0 on error
miva_openlog
miva_openlog( ident, logopt, facility )
Opens a connection to the log file and sets default behavior for all subsequent miva_writelog calls.
Returns 1 on success, 0 on error
  • ident = a string that will be prepended to all subsequent log messages. May be the empty string.
  • logopt = a string containing a list of options. Each option may be any of the words listed below. Commas and/or spaces separate the options. An empty string is permitted.
  • facility = The default facility code for subsequent messages. May be any one of the words listed below.
miva_setlogmask
miva_setlogmask( maskpri )
Causes all subsequent calls to miva_writelog to be ignored unless they specify a priority that is included in the maskpri argument. Will return failure unless the miva log is open.
Returns 1 on success, 0 on error
  • maskpri = a string containing a list of priorities. Each priority may be any of the words listed below. Commas and/or spaces separate the priorities. An empty string is permitted but means that all subsequent miva_writelog calls will be ignored.
miva_writelog
miva_writelog( priority, message )
Writes a message to the log with the specified priority. Will return failure unless the miva log is open.
Returns 1 on success, 0 on error
  • priority = a string containing a list of words. These words may be either a facility code (see miva_openlog) or a priority code (see miva_setlogmask). Commas and/or spaces separate the words. The facility may be omitted in which case the default will be assumed (see miva_openlog). If the priority is omitted or has been disabled via a call to miva_setlogmask, then the miva_writelog call will be ignored.
  • message = a string that will be written to the log.
User Annotations: logging