MSG_printProc.h File Reference

Public include file for the print output processor. More...

#include <MSG/MSG_pubdefs.h>

Defines
#define	MSG_M_TEXT   ( 0x00000001 )
	Print message text.
#define	MSG_M_NAME   ( 0x00000002 )
	Print message name.
#define	MSG_M_ROUTINE   ( 0x00000004 )
	Print routine name.
#define	MSG_M_TASK   ( 0x00000008 )
	Print task name.
#define	MSG_M_NANO   ( 0x00000010 )
	Print message time (UTC) nanoseconds.
#define	MSG_M_TIME   ( 0x00000020 )
	Print message time (UTC).
#define	MSG_M_DATE   ( 0x00000040 )
	Print message date (UTC).
#define	MSG_M_DUMP   ( 0x00000080 )
	Multi-line dump of everything (for debug).
Functions
void	MSG_print (MSG_OutputModes mode, void *prm, const MSG_Message *msg)
	Output processor callback routine to simply print messages.
void	MSG_printAttach (void)
	Attach the printing output processor to MSG.
unsigned int	MSG_printOptions (unsigned int mask, unsigned int valu)
	Selective set and clear of print processor options.

---

Detailed Description

Public include file for the print output processor.

CVS $Id: MSG_printProc.h,v 1.6 2011/03/25 01:05:52 apw Exp $

Author:

A.P.Waite

---

Function Documentation

void MSG_print	(	MSG_OutputModes	mode,
		void *	prm,
		const MSG_Message *	msg
	)

Output processor callback routine to simply print messages.

Parameters:

	mode	(in) Output processor calling mode
	prm	(in) User parameter
	msg	(in) Message structure

MSG_print prints a message using printf following options provided by the user.

References MSG_M_DATE, MSG_M_DUMP, MSG_M_NAME, MSG_M_NANO, MSG_M_ROUTINE, MSG_M_TASK, MSG_M_TEXT, and MSG_M_TIME.

Referenced by MSG_printAttach().

void MSG_printAttach

(

void

)

Attach the printing output processor to MSG.

MSG_printAttach() attaches the printing plug-in to the MSG system, with print options selected by the configuration database MPP_DB.

References MSG_M_DATE, MSG_M_NAME, MSG_M_NANO, MSG_M_ROUTINE, MSG_M_TASK, MSG_M_TEXT, MSG_M_TIME, MSG_print(), and MSG_printOptions().

unsigned int MSG_printOptions	(	unsigned int	mask,
		unsigned int	valu
	)

Selective set and clear of print processor options.

Parameters:

	mask	(in) Mask of options to touch
	valu	(in) Values to set (in masked bits only)

Return values:

x

Previous value of the options word

MSG_printOptions does a selective set and clear on the print options word.

Referenced by MSG_printAttach().