log4shib::...ogAppender(3)

log4shib::...ogAppender(3) — Library Functions Manual — okay bestie, this is the whole page, and it’s giving “Windows event log but make it documentation.” 💖

NAME 🌸

log4shib::NTEventLogAppender is an Appender that sends LoggingEvents to the Windows event log. That’s the whole vibe, no cap.

SYNOPSIS ✨

#include <NTEventLogAppender.hh>

Inherits log4shib::LayoutAppender.

Public Member Functions 💅

• NTEventLogAppender (const std::string &name, const std::string &sourceName) — instantiate an NTEventLogAppender with the given name and source.
• virtual ~NTEventLogAppender () — virtual destructor. Minimal, but iconic.
• virtual bool reopen () — calls open() and close().
• virtual void close () — release any resources allocated within the appender such as file handles, network connections, etc.

Public Member Functions inherited from log4shib::LayoutAppender 🎀

• LayoutAppender (const std::string &name) — constructor. The page gives no extra notes here.
• virtual ~LayoutAppender () — virtual destructor. No extra notes in the page.
• virtual bool requiresLayout () const — check if the appender requires a layout.
• virtual void setLayout (Layout *layout=NULL) — set the Layout for this appender.

Public Member Functions inherited from log4shib::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 log4shib::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 log4shib Priority to an EventLog category.
• WORD getType (Priority::Value priority) — convert log4shib Priority to an EventLog type.
• HKEY regGetKey (TCHAR *subkey, DWORD *disposition) — no extra notes in the page.
• void regSetString (HKEY hkey, const TCHAR *name, const TCHAR *value) — no extra notes in the page.
• void regSetDword (HKEY hkey, const TCHAR *name, DWORD value) — no extra notes in the page.
• void addRegistryInfo (const char *source) — no extra notes in the page.
• virtual void open () — no extra notes in the page.
• virtual void _append (const LoggingEvent &event) — sends a LoggingEvent to NT Event log.

Protected Member Functions inherited from log4shib::LayoutAppender 🧚

• Layout & _getLayout () — return the layout of the appender.

Protected Member Functions inherited from log4shib::AppenderSkeleton 🍓

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

Protected Member Functions inherited from log4shib::Appender 💜

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

Protected Attributes 🎀

• HANDLE _hEventSource
• std::string _strSourceName

Additional Inherited Members ⭐

Public Types inherited from log4shib::LayoutAppender

• typedef BasicLayout DefaultLayoutType

Static Public Member Functions inherited from log4shib::Appender

• static Appender * getAppender (const std::string &name) — get a pointer to an existing Appender.
• static bool reopenAll () — call reopen() on all existing Appenders.
• static void closeAll () — call reopen() on all existing Appenders. Yes, the page literally says reopen() here — iykyk.

Detailed Description 🦋

NTEventLogAppender is an Appender that sends LoggingEvents to the Windows event log. Main character behavior, honestly. 💅

Building log4shib.dsp/log4shibDLL.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. Not a cross-platform girlie, bestie. 🪟

Constructor & Destructor Documentation 🫶

🎀 Constructor — log4shib::NTEventLogAppender::NTEventLogAppender

log4shib::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

🎀 Destructor — log4shib::NTEventLogAppender::~NTEventLogAppender

log4shib::NTEventLogAppender::~NTEventLogAppender () [virtual]

Virtual destructor. The page gives no extra prose here — it’s giving minimal.

Member Function Documentation ⭐

💫 _append

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

Sends a LoggingEvent to NT Event log.

Parameters

• event — the LoggingEvent to log.

Implements log4shib::AppenderSkeleton.

💫 addRegistryInfo

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

Protected helper. The page gives no extra notes here, bestie.

💫 close

void log4shib::NTEventLogAppender::close () [virtual]

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

Implements log4shib::AppenderSkeleton.

💫 getCategory

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

Convert log4shib 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.

💫 getType

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

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

💫 open

void log4shib::NTEventLogAppender::open () [protected],  [virtual]

No extra notes in the page — just the signature doing its thing.

💫 regGetKey

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

No extra notes in the page.

💫 regSetDword

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

No extra notes in the page.

💫 regSetString

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

No extra notes in the page.

💫 reopen

bool log4shib::NTEventLogAppender::reopen () [virtual]

Calls open() and close().

Reimplemented from log4shib::AppenderSkeleton.

Member Data Documentation 🍓

• HANDLE log4shib::NTEventLogAppender::_hEventSource [protected] — no extra notes in the page.
• std::string log4shib::NTEventLogAppender::_strSourceName [protected] — no extra notes in the page.

Author 👑

Generated automatically by Doxygen for log4shib from the source code. Auto-gen royalty, honestly. 👑

---

okay bestie, that’s the whole page — footer source/version: log4shib, Version 2.0.1; the footer’s date slot is literally empty, so no date to quote and we’re not inventing one. 💖✨