WinStd
Additional templates and function helpers for Microsoft Windows using Standard C++ classes
Public Member Functions | Protected Member Functions | List of all members
winstd::event_log Class Reference

Event log handle wrapper. More...

#include <WinStd/Win.h>

Inheritance diagram for winstd::event_log:
winstd::handle< HANDLE, NULL >

Public Member Functions

virtual ~event_log ()
 Closes an event log handle. More...
 
bool open (LPCTSTR lpUNCServerName, LPCTSTR lpSourceName) noexcept
 Retrieves a registered handle to the specified event log. More...
 
- Public Member Functions inherited from winstd::handle< HANDLE, NULL >
 handle () noexcept
 Initializes a new class instance with the object handle set to INVAL.
 
 handle (handle_type h) noexcept
 Initializes a new class instance with an already available object handle. More...
 
 handle (handle< handle_type, INVAL > &&h) noexcept
 Move constructor. More...
 
handle< handle_type, INVAL > & operator= (handle_type h) noexcept
 Attaches already available object handle. More...
 
handle< handle_type, INVAL > & operator= (handle< handle_type, INVAL > &&h) noexcept
 Move assignment. More...
 
 operator handle_type () const
 Auto-typecasting operator. More...
 
handle_type *& operator* () const
 Returns the object handle value when the object handle is a pointer to a value (class, struct, etc.). More...
 
handle_typeoperator& ()
 Returns the object handle reference. More...
 
handle_type operator-> () const
 Provides object handle member access when the object handle is a pointer to a class or struct. More...
 
bool operator! () const
 Tests if the object handle is INVAL. More...
 
bool operator< (handle_type h) const
 Is handle less than? More...
 
bool operator<= (handle_type h) const
 Is handle less than or equal to? More...
 
bool operator>= (handle_type h) const
 Is handle greater than or equal to? More...
 
bool operator> (handle_type h) const
 Is handle greater than? More...
 
bool operator!= (handle_type h) const
 Is handle not equal to? More...
 
bool operator== (handle_type h) const
 Is handle equal to? More...
 
void attach (handle_type h) noexcept
 Sets a new object handle for the class. More...
 
handle_type detach ()
 Dismisses the object handle from this class. More...
 
void free ()
 Destroys the object.
 

Protected Member Functions

void free_internal () noexcept override
 Closes an event log handle. More...
 
virtual void free_internal () noexcept=0
 Abstract member function that must be implemented by child classes to do the actual object destruction. More...
 

Additional Inherited Members

- Public Types inherited from winstd::handle< HANDLE, NULL >
typedef HANDLE handle_type
 Datatype of the object handle this template class handles.
 
- Static Public Attributes inherited from winstd::handle< HANDLE, NULL >
static const HANDLE invalid
 Invalid handle value.
 
- Protected Attributes inherited from winstd::handle< HANDLE, NULL >
handle_type m_h
 Object handle.
 

Detailed Description

Event log handle wrapper.

Constructor & Destructor Documentation

◆ ~event_log()

virtual winstd::event_log::~event_log ( )
inlinevirtual

Closes an event log handle.

See also
DeregisterEventSource function

Member Function Documentation

◆ free_internal()

void winstd::event_log::free_internal ( )
inlineoverrideprotectedvirtualnoexcept

Closes an event log handle.

See also
DeregisterEventSource function

Implements winstd::handle< HANDLE, NULL >.

◆ open()

bool winstd::event_log::open ( LPCTSTR  lpUNCServerName,
LPCTSTR  lpSourceName 
)
inlinenoexcept

Retrieves a registered handle to the specified event log.

See also
RegisterEventSource function
Returns
  • true when succeeds;
  • false when fails. Use GetLastError() for failure reason.

The documentation for this class was generated from the following file: