stumpless 2.2.0
Loading...
Searching...
No Matches
wel_supported.h
Go to the documentation of this file.
1/* SPDX-License-Identifier: Apache-2.0 */
2
3/*
4 * Copyright 2018-2024 Joel E. Anderson
5 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 */
18
24#ifndef __STUMPLESS_CONFIG_WEL_SUPPORTED_H
25# define __STUMPLESS_CONFIG_WEL_SUPPORTED_H
26
27/*
28 * We always include windows.h first, as it sets up definitions that often cause
29 * problems if they aren't first.
30 */
31# include <windows.h>
32
33# include <stdarg.h>
34# include <stumpless/config.h>
35# include <stumpless/entry.h>
36# include <stumpless/param.h>
37
38# ifdef __cplusplus
39extern "C" {
40# endif
41
91DWORD
93
163DWORD
165 LPCSTR source_name,
166 DWORD category_count,
167 LPCSTR category_file,
168 LPCSTR event_file,
169 LPCSTR param_file,
170 DWORD types_supported );
171
239DWORD
241 LPCWSTR source_name,
242 DWORD category_count,
243 LPCWSTR category_file,
244 LPCWSTR event_file,
245 LPCWSTR param_file,
246 DWORD types_supported );
247
273WORD
275
303DWORD
305
335struct stumpless_param *
337 WORD index );
338
379LPCSTR
381 WORD index );
382
418LPCWSTR
420 WORD index );
421
449WORD
451
478DWORD
480
513DWORD
515 LPCSTR source_name );
516
548DWORD
550 LPCWSTR source_name );
551
581struct stumpless_entry *
582stumpless_set_wel_category( struct stumpless_entry *entry, WORD category );
583
612struct stumpless_entry *
613stumpless_set_wel_event_id( struct stumpless_entry *entry, DWORD event_id );
614
663struct stumpless_entry *
665 WORD index,
666 const struct stumpless_param *param );
667
712struct stumpless_entry *
714 WORD index,
715 LPCSTR str );
716
764struct stumpless_entry *
766 WORD index,
767 LPCWSTR str );
768
806struct stumpless_entry *
808 WORD count,
809 ... );
810
851struct stumpless_entry *
853 WORD count,
854 ... );
855
884struct stumpless_entry *
885stumpless_set_wel_type( struct stumpless_entry *entry, WORD type );
886
927struct stumpless_entry *
929 WORD count,
930 va_list insertions );
931
972struct stumpless_entry *
974 WORD count,
975 va_list insertions );
976
977# ifdef __cplusplus
978} /* extern "C" */
979# endif
980#endif /* __STUMPLESS_CONFIG_WEL_SUPPORTED_H */
#define STUMPLESS_PUBLIC_FUNCTION
Marks functions that are provided for use by the library.
Definition config.h:31
Types and functions for creating and modifying entries.
Types and functions for creating and modifying params.
A log entry.
Definition entry.h:60
A parameter within a structured data element.
Definition param.h:93
STUMPLESS_PUBLIC_FUNCTION struct stumpless_entry * vstumpless_set_wel_insertion_strings(struct stumpless_entry *entry, WORD count, va_list insertions)
Sets the insertion strings of a Windows Even Log entry.
STUMPLESS_PUBLIC_FUNCTION struct stumpless_entry * stumpless_set_wel_category(struct stumpless_entry *entry, WORD category)
Sets the category of an entry for use with a Windows Event Log target.
STUMPLESS_PUBLIC_FUNCTION DWORD stumpless_remove_wel_event_source(LPCSTR subkey_name, LPCSTR source_name)
Removes the registry entries for an event source for the Windows Event Log.
STUMPLESS_PUBLIC_FUNCTION DWORD stumpless_add_default_wel_event_source(void)
Creates the registry entries for displaying default entries in the Windows Event Log.
STUMPLESS_PUBLIC_FUNCTION LPCWSTR stumpless_get_wel_insertion_string_w(const struct stumpless_entry *entry, WORD index)
Gets an insertion string from a Windows Event Log entry.
STUMPLESS_PUBLIC_FUNCTION struct stumpless_entry * stumpless_set_wel_insertion_strings(struct stumpless_entry *entry, WORD count,...)
Sets the insertion strings of a Windows Event Log entry.
STUMPLESS_PUBLIC_FUNCTION struct stumpless_entry * stumpless_set_wel_insertion_strings_w(struct stumpless_entry *entry, WORD count,...)
Sets the insertion strings of a Windows Event Log entry.
STUMPLESS_PUBLIC_FUNCTION DWORD stumpless_add_wel_event_source(LPCSTR subkey_name, LPCSTR source_name, DWORD category_count, LPCSTR category_file, LPCSTR event_file, LPCSTR param_file, DWORD types_supported)
Creates or updates the registry entries for displaying log entries in the Windows Event Log for a new...
STUMPLESS_PUBLIC_FUNCTION struct stumpless_param * stumpless_get_wel_insertion_param(const struct stumpless_entry *entry, WORD index)
Gets an insertion param from a Windows Event Log entry.
STUMPLESS_PUBLIC_FUNCTION struct stumpless_entry * vstumpless_set_wel_insertion_strings_w(struct stumpless_entry *entry, WORD count, va_list insertions)
Sets the insertion strings of a Windows Even Log entry.
STUMPLESS_PUBLIC_FUNCTION struct stumpless_entry * stumpless_set_wel_event_id(struct stumpless_entry *entry, DWORD event_id)
Sets the event id of an entry for use with a Windows Event Log target.
STUMPLESS_PUBLIC_FUNCTION struct stumpless_entry * stumpless_set_wel_insertion_string(struct stumpless_entry *entry, WORD index, LPCSTR str)
Sets a string to use for string insertion in a Windows Event Log entry.
STUMPLESS_PUBLIC_FUNCTION struct stumpless_entry * stumpless_set_wel_type(struct stumpless_entry *entry, WORD type)
Sets the type of an entry for use with a Windows Event Log target.
STUMPLESS_PUBLIC_FUNCTION DWORD stumpless_remove_default_wel_event_source(void)
Removes the registry entries for the event source for default WEL entries.
STUMPLESS_PUBLIC_FUNCTION WORD stumpless_get_wel_type(const struct stumpless_entry *entry)
Gets the type of an entry used with Windows Event Log targets.
STUMPLESS_PUBLIC_FUNCTION WORD stumpless_get_wel_category(const struct stumpless_entry *entry)
Gets the category of an entry used with Windows Event Log targets.
STUMPLESS_PUBLIC_FUNCTION struct stumpless_entry * stumpless_set_wel_insertion_param(struct stumpless_entry *entry, WORD index, const struct stumpless_param *param)
Sets a param to use for string insertion in a Windows Event Log entry.
STUMPLESS_PUBLIC_FUNCTION DWORD stumpless_get_wel_event_id(const struct stumpless_entry *entry)
Gets the event id of an entry used with Windows Event Log targets.
STUMPLESS_PUBLIC_FUNCTION DWORD stumpless_add_wel_event_source_w(LPCWSTR subkey_name, LPCWSTR source_name, DWORD category_count, LPCWSTR category_file, LPCWSTR event_file, LPCWSTR param_file, DWORD types_supported)
Creates or updates the registry entries for displaying log entries in the Windows Event Log for a new...
STUMPLESS_PUBLIC_FUNCTION DWORD stumpless_remove_wel_event_source_w(LPCWSTR subkey_name, LPCWSTR source_name)
Removes the registry entries for an event source for the Windows Event Log.
STUMPLESS_PUBLIC_FUNCTION struct stumpless_entry * stumpless_set_wel_insertion_string_w(struct stumpless_entry *entry, WORD index, LPCWSTR str)
Sets a string to use for string insertion in a Windows Event Log entry.
STUMPLESS_PUBLIC_FUNCTION LPCSTR stumpless_get_wel_insertion_string(const struct stumpless_entry *entry, WORD index)
Gets an insertion string from a Windows Event Log entry.