LOG4CPP::NTEVENTLOGAPPENDER(3)

🎀 log4cpp::NTEventLogAppender(3) — Library Functions Manual 🎀

okay bestie, welcome to the Library Functions Manual page for log4cpp::NTEventLogAppender(3). We're gonna get you comfy with this Windows-event-log appender, no cap. 💖

✨ NAME ✨

log4cpp::NTEventLogAppender — an Appender that sends LoggingEvents to the Windows event log. 💅

🌸 SYNOPSIS 🌸

#include <NTEventLogAppender.hh>

Inherits log4cpp::AppenderSkeleton.

💖 Public Member Functions 💖

• NTEventLogAppender (const std::string &name, const std::string &sourceName) — instantiate an NTEventLogAppender with the given name and source.
• virtual ~NTEventLogAppender () — the virtual destructor.
• virtual bool reopen () — calls open() and close().
• virtual void close () — release any resources allocated within the appender such as file handles, network connections, etc.
• virtual bool requiresLayout () const — the NTEventLogAppender does its own Layout.
• virtual void setLayout (Layout *layout) — set the Layout for this appender.

🦋 Public Member Functions inherited from log4cpp::AppenderSkeleton 🦋

• virtual ~AppenderSkeleton () — destructor for AppenderSkeleton.
• virtual void doAppend (const LoggingEvent &event) — log in Appender specific way.
• virtual void setThreshold (Priority::Value priority) — set the threshold priority of this Appender.
• virtual Priority::Value getThreshold () — get the threshold priority of this Appender.
• virtual void setFilter (Filter *filter) — set a Filter for this appender.
• virtual Filter *getFilter () — get the Filter for this appender.

🧚 Public Member Functions inherited from log4cpp::Appender 🧚

• virtual ~Appender () — destructor for Appender.
• const std::string &getName () const — get the name of this appender.

🫶 Protected Member Functions 🫶

• WORD getCategory (Priority::Value priority) — convert log4cpp Priority to an EventLog category.
• WORD getType (Priority::Value priority) — convert log4cpp Priority to an EventLog type.
• HKEY regGetKey (TCHAR *subkey, DWORD *disposition) — protected helper, no extra deets on the page.
• void regSetString (HKEY hkey, TCHAR *name, TCHAR *value) — protected helper, no extra deets on the page.
• void regSetDword (HKEY hkey, TCHAR *name, DWORD value) — protected helper, no extra deets on the page.
• void addRegistryInfo (const char *source) — protected helper, no extra deets on the page.
• virtual void open () — protected virtual helper, no extra deets on the page.
• virtual void _append (const LoggingEvent &event) — sends a LoggingEvent to NT Event log.

🌈 Protected Member Functions inherited from log4cpp::AppenderSkeleton 🌈

• AppenderSkeleton (const std::string &name) — constructor for AppenderSkeleton.

🍓 Protected Member Functions inherited from log4cpp::Appender 🍓

• Appender (const std::string &name) — constructor for Appender.

👑 Protected Attributes 👑

• HANDLE _hEventSource
• std::string _strSourceName

⭐ Additional Inherited Members ⭐

💜 Static Public Member Functions inherited from log4cpp::Appender 💜

• static Appender *getAppender (const std::string &name) — get a pointer to an exitsing Appender.
• static bool reopenAll () — call reopen() on all existing Appenders.
• static void closeAll () — call reopen() on all existing Appenders. (yes, the original says reopen() here too — keeping it exactly as written. 🫡)

🔥 Detailed Description 🔥

NTEventLogAppender is an Appender that sends LoggingEvents to the Windows event log. Iconic.

Building log4cpp.dsp/log4cppDLL.dsp creates the resource DLL NTEventLogAppender.dll. Do not forget to place this DLL in a directory that is on the PATH of the Windows system. Otherwise, the category and message will not display correctly in Event Viewer. 💀

NB: This class is only available on Win32 platforms.

🎀 Constructor & Destructor Documentation 🎀

🎀 log4cpp::NTEventLogAppender::NTEventLogAppender (const std::string & name, const std::string & sourceName) 🎀

Instantiate an NTEventLogAppender with given name and source.

• Parameters
  • name — the name of the Appender
  • sourceName — the source name to log

💀 log4cpp::NTEventLogAppender::~NTEventLogAppender () [virtual] 💀

The virtual destructor. No extra description on the page.

🔥 Member Function Documentation 🔥

🫶 void log4cpp::NTEventLogAppender::_append (const LoggingEvent & event) [protected], [virtual] 🫶

Sends a LoggingEvent to NT Event log.

• Parameters
  • event — the LoggingEvent to log.

Implements log4cpp::AppenderSkeleton.

🧚 void log4cpp::NTEventLogAppender::addRegistryInfo (const char * source) [protected] 🧚

Protected helper, no extra description on the page.

🦋 void log4cpp::NTEventLogAppender::close () [virtual] 🦋

Release any resources allocated within the appender such as file handles, network connections, etc.

Implements log4cpp::AppenderSkeleton.

🌸 WORD log4cpp::NTEventLogAppender::getCategory (Priority::Value priority) [protected] 🌸

Convert log4cpp Priority to an EventLog category. Each category is backed by a message resource so that proper category names will be displayed in the NT Event Viewer.

⭐ WORD log4cpp::NTEventLogAppender::getType (Priority::Value priority) [protected] ⭐

Convert log4cpp Priority to an EventLog type. The log4cpp package supports 8 defined priorites, but the NT EventLog only knows 3 event types of interest to us: ERROR, WARNING, and INFO.

🎀 void log4cpp::NTEventLogAppender::open () [protected], [virtual] 🎀

Protected virtual helper, no extra description on the page.

💜 HKEY log4cpp::NTEventLogAppender::regGetKey (TCHAR * subkey, DWORD * disposition) [protected] 💜

Protected helper, no extra description on the page.

🍓 void log4cpp::NTEventLogAppender::regSetDword (HKEY hkey, TCHAR * name, DWORD value) [protected] 🍓

Protected helper, no extra description on the page.

🌈 void log4cpp::NTEventLogAppender::regSetString (HKEY hkey, TCHAR * name, TCHAR * value) [protected] 🌈

Protected helper, no extra description on the page.

💖 bool log4cpp::NTEventLogAppender::reopen () [virtual] 💖

Calls open() and close().

Reimplemented from log4cpp::AppenderSkeleton.

👑 bool log4cpp::NTEventLogAppender::requiresLayout () const [virtual] 👑

The NTEventLogAppender does its own Layout.

• Returns
  • false

Implements log4cpp::AppenderSkeleton.

✨ void log4cpp::NTEventLogAppender::setLayout (Layout * layout) [virtual] ✨

Set the Layout for this appender.

• Parameters
  • layout — the layout to use.

Implements log4cpp::AppenderSkeleton.

🌸 Member Data Documentation 🌸

• HANDLE log4cpp::NTEventLogAppender::_hEventSource [protected] — protected member data.
• std::string log4cpp::NTEventLogAppender::_strSourceName [protected] — protected member data.

⭐ Author ⭐

Generated automatically by Doxygen for log4cpp from the source code.

---

This whole page is from log4cpp Version 1.1, and the footer says log4cpp::N...LogAppender(3) — that's the sign-off bestie, periodt. 🫶💅🎀