DtMsgLogMessage man page on HP-UX

Printed from http://www.polarhome.com/service/man/?qf=DtMsgLogMessage&af=0&tf=2&of=HP-UX

DtMsgLogMessage(library call)			 DtMsgLogMessage(library call)

       DtMsgLogMessage — logs a message

       #include <Dt/MsgLog.h>
       void DtMsgLogMessage(
       const char* program_name,
       DtMsgLogType msg_type,
       const char* format,
       va_list args);

       The  DtMsgLogMessage  function logs the given arguments in one message.
       The format of the message is specified by format and thus is controlled
       by the application. The format of each logged entry is:

       *** <Msgtype_string>( <Msg_type>):  <Program_name>: PID	<Proc_id>:  <Date>
       *** [ <Bytes_output>]

       The  value  of  <Msgtype_string>	 depends on the value of msg_type. Its
       value is:

		 if msg_type is DtMsgLogInformation

       STDERR	 if msg_type is DtMsgLogStderr

       DEBUG	 if msg_type is DtMsgLogDebug

       WARNING	 if msg_type is DtMsgLogWarning

       ERROR	 if msg_type is DtMsgLogError

       UNKNOWN	 for all other values of msg_type

       <Msgtype_string> is prefaced with the string *** and one space  charac‐
       ter.   <Msg_type>  is  replaced with the value of the msg_type argument
       (placed within parentheses).  <Program_name> is replaced with the value
       of  the	program_name.	<Proc_id>  is  the  application's  process id.
       <Date> is the date and time the message is  logged.   <The_message>  is
       the   formatted	 message   including  the  arguments.	<Bytes_output>
       (enclosed in brackets) is replaced with the number of bytes output  for
       the  message  and header information.  (The number of bytes printed for
       the line containing <Bytes_output> is not included.).  A	 colon	and  a
       space  (respectively)  are  printed  after  the closing parenthesis for
       <Msg_type>, <Program_name>, and <Proc_id>.

       One newline is output after the date and one newline  is	 output	 after
       the message. After the message, a line beginning with the string *** is
       output, followed by a space character, a [  character,  the  number  of
       bytes printed, a ] character, and,finally, two newlines (one blank line
       separates messages).

       The message type string and date specification are localized  and  thus
       are  retrieved  from  the  current locale's message catalog.  It is the
       application's responsibility to localize the message to be logged.

       An example log entry is:

       *** WARNING(3): fontview: PID 12312: Thu Jun 13 16:51:51 1995
       The specified font 'fixed' could not be loaded.
       *** [109]

       To log a multi-line message, use a single call to DtMsgLogMessage.

       DtMsgLogMessage attempts to open the following files in	the  indicated
       sequence	 (by  calling  the fopen function with the a+ option). It uses
       the first file that is successfully opened.

		 This file is used only if the environment  variable  HOME  is

		 This file is used only if the environment variable DTUSERSES‐
		 SION is defined.

		 In this filename, <user_name> is replaced by the user's login
		 name.	The  login name is determined by using the environment
		 variable LOGNAME, if it is defined, or USER,  if  LOGNAME  is
		 not  defined. If neither variable is defined, DtMsgLogMessage
		 uses the getpwuid function to determine <user_name>.

       DtMsgLogMessage calls DtMsgLogOpenFile to determine where  to  log  the
       message.	 If DtMsgLogOpenFile returns NULL, DtMsgLogMessage will output
       the message to stderr.

		 Specifies a string "tag" to identify the application  issuing
		 the  message.	This  is generally an application's argv[0] so
		 the message can be traced to an executable program.

       msg_type	 Specifies the DtMsgLogType structure that defines the message
		 type. See "Structures" in this man page.

       format	 Specifies the sprintf format of the message.

       args	 Specifies the variable number of arguments needed by format.

       The  msg_type  argument is specified as a DtMsgLogType enumeration data
       type, with the following members:

		 Designates informational messages that	 do  not  have	to  be
		 brought  to the user's immediate attention (for example, sta‐
		 tus information).  It is acceptable to not  present  messages
		 of this type to the user.

		 Designates debugging messages written by the application (for
		 example, via a -debug command line option).

		 Designates messages that an application produces to  log  the
		 stderr from a child process.

		 Designates  messages for errors that are not severe enough to
		 cause program termination.

		 Designates messages for fatal	errors	that  require  program


       The  values of the following environment variables determine which file
       is opened by DtMsgLogMessage: HOME, LOGNAME, USER,  and	DTUSERSESSION.
       See "Description" in this man page for more information.

       Because	DtMsgLogMessage	 calls	the catopen function, it is indirectly
       influenced by the environment variables that affect  catopen,  such  as
       LANG, and NLSPATH.  See catopen(3) for more information.


       The  default  mechanism	to view the message log is to invoke the Watch
       Errors action which is  located	in  the	 Application  Manager's	 Desk‐
       top_Tools folder.


       The  following code fragment illustrates how to log a localized warning

       #include <nl_types.h>

       char *s1, *s2; /* temp strings - catgets may return
			 a pointer to a static buffer */
       nl_catd catd = catopen ("app.cat", 0);
       s1	    = strdup (catgets (catd, 4, 10, "string 1"));
       s2	    = strdup (catgets (catd, 4, 10, "string 2"));
       DtMsgLogMessage (argv[0],
	     "%s %s",
	     s1, s2);

       See DtMsgLogOpenFile(3).

       DtMsgLogOpenFile(3), DtMsgLogSetHandler(3)

						 DtMsgLogMessage(library call)

List of man pages available for HP-UX

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
Vote for polarhome
Free Shell Accounts :: the biggest list on the net