DTMSGLOGOPENFILE(3)

💖 DtMsgLogOpenFile — the log-file-opening bestie 💖

okay so this is the library call manual page for DtMsgLogOpenFile, and if you've ever been like “where is this program even logging??” — bestie, same. This function opens a log file. That's the assignment. Slay. ✨

✨ NAME ✨

DtMsgLogOpenFile — opens a log file

🌸 SYNOPSIS 🌸

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

bestie, the &<Dt/MsgLog.h> is exactly what the page has. Do not come for me. 💅

🦋 DESCRIPTION 🦋

So DtMsgLogOpenFile 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, then DtMsgLogOpenFile calls malloc to allocate space for filename_return. After that, it copies the log file name to filename_return. Iconic behavior, no cap. 🌈

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 doing this because stderr may be returned. Like, actual caution, bestie — not decorative caution. 😭

For a description of the algorithm used to determine the log file to open, see DtMsgLogMessage(3). Also note: 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 information.
• 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);

Copy that exactly as printed, bestie — the &&log_file and &&&& are giving “do not edit the sacred text” energy. 🙈

👑 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. Yes, the page really says DtMsgLogMessage in this return-value sentence — I am preserving it exactly, not doing a little autocorrect moment. 💀

🧚 FILES 🧚

None.

💫 SEE ALSO 💫

DtMsgLogMessage(3), DtMsgLogSetHandler(3)

---

okay that's the whole thing. Source/version footer vibe: DtMsgLogOpenFile(library call). Date: this page doesn't show one, so I'm not inventing a date — we don't do fan fiction in manpages, bestie 💅🎀