stumpless  2.1.0
wel_supported.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: Apache-2.0 */
2 
3 /*
4  * Copyright 2018-2022 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
39 extern "C" {
40 # endif
41 
91 DWORD
93 
163 DWORD
164 stumpless_add_wel_event_source( LPCSTR subkey_name,
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 
239 DWORD
240 stumpless_add_wel_event_source_w( LPCWSTR subkey_name,
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 
273 WORD
275 
303 DWORD
305 
335 struct stumpless_param *
337  WORD index );
338 
379 LPCSTR
381  WORD index );
382 
418 LPCWSTR
420  WORD index );
421 
449 WORD
451 
478 DWORD
480 
513 DWORD
515  LPCSTR source_name );
516 
548 DWORD
550  LPCWSTR source_name );
551 
581 struct stumpless_entry *
582 stumpless_set_wel_category( struct stumpless_entry *entry, WORD category );
583 
612 struct stumpless_entry *
613 stumpless_set_wel_event_id( struct stumpless_entry *entry, DWORD event_id );
614 
663 struct stumpless_entry *
665  WORD index,
666  const struct stumpless_param *param );
667 
712 struct stumpless_entry *
714  WORD index,
715  LPCSTR str );
716 
764 struct stumpless_entry *
766  WORD index,
767  LPCWSTR str );
768 
806 struct stumpless_entry *
808  WORD count,
809  ... );
810 
851 struct stumpless_entry *
853  WORD count,
854  ... );
855 
884 struct stumpless_entry *
885 stumpless_set_wel_type( struct stumpless_entry *entry, WORD type );
886 
927 struct stumpless_entry *
929  WORD count,
930  va_list insertions );
931 
972 struct 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 */
stumpless_set_wel_insertion_param
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_set_wel_insertion_string_w
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_add_default_wel_event_source
DWORD stumpless_add_default_wel_event_source(void)
Creates the registry entries for displaying default entries in the Windows Event Log.
stumpless_get_wel_insertion_string_w
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_set_wel_insertion_strings
struct stumpless_entry * stumpless_set_wel_insertion_strings(struct stumpless_entry *entry, WORD count,...)
Sets the insertion strings of a Windows Event Log entry.
vstumpless_set_wel_insertion_strings_w
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_param
A parameter within a structured data element.
Definition: param.h:90
entry.h
stumpless_get_wel_type
WORD stumpless_get_wel_type(const struct stumpless_entry *entry)
Gets the type of an entry used with Windows Event Log targets.
stumpless_get_wel_category
WORD stumpless_get_wel_category(const struct stumpless_entry *entry)
Gets the category of an entry used with Windows Event Log targets.
param.h
stumpless_get_wel_insertion_param
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_set_wel_event_id
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_add_wel_event_source
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_set_wel_insertion_strings_w
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_set_wel_category
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_get_wel_event_id
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
#define STUMPLESS_PUBLIC_FUNCTION
Marks functions that are provided for use by the library.
Definition: config.h:31
stumpless_set_wel_insertion_string
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_remove_default_wel_event_source
DWORD stumpless_remove_default_wel_event_source(void)
Removes the registry entries for the event source for default WEL entries.
config.h
stumpless_remove_wel_event_source_w
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.
vstumpless_set_wel_insertion_strings
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_remove_wel_event_source
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_get_wel_insertion_string
LPCSTR stumpless_get_wel_insertion_string(const struct stumpless_entry *entry, WORD index)
Gets an insertion string from a Windows Event Log entry.
stumpless_set_wel_type
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_entry
A log entry.
Definition: entry.h:63
stumpless_add_wel_event_source_w
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...