Next: Abstract

MERS (MSG and ERR)

Message and Error Reporting Systems
Version 2.1
Programmer's Manual

Starlink User Note 104.12
P C T Rees
A J Chipperfield
T Jenness
23 July 2009

Joint Astronomy Centre
Science & Technology Facilties Council

Starlink Project

Retrieve hardcopy

Abstract
Introduction
MSG - Message Reporting System
- Overview
- Reporting messages
- Conditional message reporting
- Conditional Message Reporting and msgOut
- Message tokens
- Formatted tokens from C
- Formatted tokens from Fortran
- Direct formatted message output with msgOut
- Including escape characters in messages
- Intercepting messages
- Renewing annulled message tokens
- Resilience
ERR - Error Reporting System
- Overview
- Inherited status checking
- Setting and defining status values
- Reporting errors
- Message tokens in error messages
- When to report an error
- The content of error messages
- Adding contextual information
- Deferred error reporting
- Error table limits
- Format of delivered messages
- Routines which perform ``cleaning-up'' operations
- Intercepting error messages
- Protecting tokens
- Reporting Status, Fortran I/O and operating system errors
- Incorporating foreign routines
- Converting existing subroutine libraries
Tuning
The C Interface
Compiling and Linking with MSG and ERR
References
Include Files
Subroutine List
- Message System subroutines
- Error System subroutines
- ADAM-special user subroutines
- ADAM-special system subroutines
C Interface Function Prototypes
Subroutine Specifications
- Message System subroutines
- MSG_BELL - Deliver an ASCII BEL character
- MSG_BLANK - Output a blank line
- MSG_FMTx - Assign a value to a message token (formatted)
- MSG_IFLEV - Return the current filter level for conditional message output
- MSG_IFSET - Set the filter level for conditional message output
- MSG_LOAD - Expand and return a message
- MSG_OUT - Output a message
- MSG_OUTIF - Conditionally deliver the text of a message to the user
- MSG_RENEW - Renew any annulled message tokens in the current context
- MSG_SETx - Assign a value to a message token (concise)
- MSG_TUNE - Set an MSG tuning parameter
- Error System subroutines
- ERR_ANNUL - Annul the contents of the current error context
- ERR_BEGIN - Create a new error reporting environment
- ERR_END - End the current error reporting environment
- ERR_FACER - Assign a Starlink facility status message to a token
- ERR_FIOER - Assign a Fortran I/O error message to a token
- ERR_FLBEL - Deliver an ASCII BEL and flush the current error context
- ERR_FLUSH - Flush the current error context
- ERR_LEVEL - Inquire the current error context level
- ERR_LOAD - Return error messages from the current error context
- ERR_MARK - Mark (start) a new error context
- ERR_REP - Report an error message
- ERR_RLSE - Release (end) the current error context
- ERR_STAT - Inquire the last reported error status
- ERR_SYSER - Assign an operating system error message to a token
- ERR_TUNE - Set an ERR tuning parameter
- Deprecated Routine ERR_OUT
  - ERR_OUT - Report a message then flush and annul the current error context.
Using MSG and ERR within ADAM
- Overview
- Using MSG within ADAM applications
- Using ERR within ADAM applications
- Using the Error Message Service for ADAM system programming
- ADAM-special subroutine specifications
  - MSG_IFGET - Get the filter level for conditional message output from the ADAM parameter system
  - MSG_SYNC - Synchronise message output via the user interface
Portability
- Overview
- Coding and porting prerequisites
- Operating system specific routines
Calculating Globally Unique Error Codes
Changes and New Features in Version 1.4
Changes and New Features in Version 1.4-1
Changes and New Features in Version 1.5
Changes and New Features in Version 1.6
Changes and New Features in Version 1.7
Changes in Version 1.7-1
Changes in Version 1.8
Changes in Version 1.8-1
Changes in Version 1.8-2
About this document ...

Next: Abstract

MERS (MSG and ERR) Message and Error Reporting Systems
Starlink User Note 104
P C T Rees
A J Chipperfield
T Jenness
23 July 2009
E-mail:ussc@star.rl.ac.uk

Copyright © 2009 Science and Technology Facilities Council

MERS (MSG and ERR) Message and Error Reporting Systems Version 2.1 Programmer's Manual

Joint Astronomy Centre Science & Technology Facilties Council

Starlink Project

Contents

MERS (MSG and ERR)

Message and Error Reporting Systems
Version 2.1
Programmer's Manual

Joint Astronomy Centre
Science & Technology Facilties Council