Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
DtMsgLogOpenFile(library call)			DtMsgLogOpenFile(library call)

NAME
       DtMsgLogOpenFile	-- opens a log file

SYNOPSIS
       #include	<Dt/MsgLog.h>
       FILE* DtMsgLogOpenFile(
       const char* type,
       char** filename_return);

DESCRIPTION
       The  DtMsgLogOpenFile function calls fopen to open a log	file with type
       open mode. If fopen opens a log file successfully and  returns  a  non-
       NULL  filename_return,  DtMsgLogOpenFile	calls malloc to	allocate space
       for filename_return.  DtMsgLogOpenFile then copies the log file name to
       filename_return.

       The  caller  must  use the free function	to release the space allocated
       for filename_return, if it is not NULL. The caller must also close  the
       file  pointer  returned	by DtMsgLogOpenFile. Use caution in doing this
       because stderr may be returned.

       For a description of the	algorithm used to determine the	 log  file  to
       open, see DtMsgLogMessage(3). Note that if a log	file cannot be opened,
       filename_return will be set to NULL.

ARGUMENTS
       type	 Specifies the file open flag. See fopen(3) for	more  informa-
		 tion.

       filename_return
		 Specifies the variable	to receive the returned	log file name.

ENVIRONMENT VARIABLES
       None.

RESOURCES
       None.

ACTIONS/MESSAGES
       None.

ERRORS/WARNINGS
       None.

EXAMPLES
       The following code fragment opens the log file, logs the	log file name,
       closes the file,	and frees the space allocated for the file name.

       char * log_file;
       FILE * fp = DtMsgLogOpenFile ("a+", &log_file);

       if (log_file) {
	   DtMsgLogMessage (argv[0], DtMsgLogInformation,
		 "The log file name is:	%s", log_file);
	   free	(log_file);
       }
       if (fp && fp != stderr)
	    fclose (fp);

RETURN VALUE
       If DtMsgLogMessage completes successfully, it returns a pointer to  the
       opened log file.	 If it cannot open a log file, it returns stderr.

FILES
       None.

SEE ALSO
       DtMsgLogMessage(3), DtMsgLogSetHandler(3)

						DtMsgLogOpenFile(library call)

NAME | SYNOPSIS | DESCRIPTION | ARGUMENTS | ENVIRONMENT VARIABLES | RESOURCES | ACTIONS/MESSAGES | ERRORS/WARNINGS | EXAMPLES | RETURN VALUE | FILES | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=DtMsgLogOpenFile&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help