From 3599c6ac6a1f756f3955b6710f5d5e3bbebcab0b Mon Sep 17 00:00:00 2001 From: Kuba Sunderland-Ober Date: Fri, 5 Jun 2026 09:19:36 +0200 Subject: [PATCH] Undocument the private EventLogTypeConstants. --- .../WinEventLogLib/EventLogTypeConstants.md | 26 ------------------- .../Built-In/WinEventLogLib/index.md | 4 --- 2 files changed, 30 deletions(-) delete mode 100644 docs/Reference/Built-In/WinEventLogLib/EventLogTypeConstants.md diff --git a/docs/Reference/Built-In/WinEventLogLib/EventLogTypeConstants.md b/docs/Reference/Built-In/WinEventLogLib/EventLogTypeConstants.md deleted file mode 100644 index a9ba37b1..00000000 --- a/docs/Reference/Built-In/WinEventLogLib/EventLogTypeConstants.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: EventLogTypeConstants -parent: WinEventLogLib Package -permalink: /tB/Packages/WinEventLogLib/EventLogTypeConstants -has_toc: false ---- -# EventLogTypeConstants -{: .no_toc } - -The Windows Event Log entry-type values. Corresponds to the Win32 `EVENTLOG_*` type constants passed to `ReportEventW`. - -| Constant | Value | Description | -|----------|-------|-------------| -| **vbEventLogTypeSuccess**{: #vbEventLogTypeSuccess } | 0 | An information entry. Maps to the Win32 `EVENTLOG_SUCCESS` constant. This is the type written by [**EventLog.LogSuccess**](EventLog#logsuccess). | -| **vbEventLogTypeError**{: #vbEventLogTypeError } | &H1 | An error entry. Maps to the Win32 `EVENTLOG_ERROR_TYPE` constant. This is the type written by [**EventLog.LogFailure**](EventLog#logfailure). | -| **vbEventLogTypeWarning**{: #vbEventLogTypeWarning } | &H2 | A warning entry. Maps to the Win32 `EVENTLOG_WARNING_TYPE` constant. | -| **vbEventLogTypeAuditSuccess**{: #vbEventLogTypeAuditSuccess } | &H8 | A success-audit entry. Maps to the Win32 `EVENTLOG_AUDIT_SUCCESS` constant. Typically used in the Security log; not applicable to the Application log. | -| **vbEventLogTypeAuditFailure**{: #vbEventLogTypeAuditFailure } | &H10 | A failure-audit entry. Maps to the Win32 `EVENTLOG_AUDIT_FAILURE` constant. Typically used in the Security log; not applicable to the Application log. | - -> [!NOTE] -> The current [**EventLog**](EventLog) public API exposes only [**LogSuccess**](EventLog#logsuccess) (type **vbEventLogTypeSuccess**) and [**LogFailure**](EventLog#logfailure) (type **vbEventLogTypeError**). The **Warning**, **AuditSuccess**, and **AuditFailure** constants are not yet reachable through the generic class. - -### See Also - -- [EventLog](EventLog) -- the generic event-log source class -- [EventLogHelperPublic](EventLogHelperPublic) -- the low-level registry helper diff --git a/docs/Reference/Built-In/WinEventLogLib/index.md b/docs/Reference/Built-In/WinEventLogLib/index.md index 35764f5e..17df93b2 100644 --- a/docs/Reference/Built-In/WinEventLogLib/index.md +++ b/docs/Reference/Built-In/WinEventLogLib/index.md @@ -154,10 +154,6 @@ The three other Windows Event Log entry types --- **Warning**, **Audit Success** - [New](EventLog#new) -- constructs an **EventLog** instance bound to a single source name - [Register](EventLog#register) -- writes the registry entries that declare this EXE as the message provider for the source -## Enumerations - -- [EventLogTypeConstants](EventLogTypeConstants) -- the Windows Event Log entry-type constants (`EVENTLOG_SUCCESS`, `EVENTLOG_ERROR_TYPE`, etc.) passed to `ReportEventW` - ## Modules - [EventLogHelperPublic](EventLogHelperPublic) -- the low-level registry helper underlying [**EventLog.Register**](EventLog#register); call it directly only when a category count must be supplied without using the generic class