diff options
Diffstat (limited to 'support/dktools/dk4wreg8.h')
-rw-r--r-- | support/dktools/dk4wreg8.h | 225 |
1 files changed, 225 insertions, 0 deletions
diff --git a/support/dktools/dk4wreg8.h b/support/dktools/dk4wreg8.h new file mode 100644 index 0000000000..613c9069c7 --- /dev/null +++ b/support/dktools/dk4wreg8.h @@ -0,0 +1,225 @@ +/* + WARNING: This file was generated by dkct. + Changes you make here will be lost if dkct is run again! + You should modify the original source and run dkct on it. + Original source: dk4wreg8.ctr +*/ + +/* +Copyright (C) 2015-2017, Dirk Krause + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +* Redistributions of source code must retain the above copyright notice, + this list of conditions and the following disclaimer. +* Redistributions in binary form must reproduce the above opyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. +* Neither the name of the author nor the names of contributors may be used + to endorse or promote products derived from this software without specific + prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +ARE DISCLAIMED. +IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY +DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND +ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +*/ + +#ifndef DK4WREG8_H_INCLUDED +/** Avoid multiple inclusions. */ +#define DK4WREG8_H_INCLUDED 1 + + +#line 10 "dk4wreg8.ctr" + +/** @file + Access Windows registry, use + 8 bit character names. + + CRT on Windows: Optional. +*/ + +#ifndef DK4CONF_H_INCLUDED +#include "dk4conf.h" +#endif + +#ifndef DK4TYPES_H_INCLUDED +#include "dk4types.h" +#endif + +#ifndef DK4ERROR_H_INCLUDED +#include "dk4error.h" +#endif + +#ifndef DK4WREGK_H_INCLUDED +#include "dk4wregk.h" +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +/** Open a registry key. + @param pk Parent key identifier. + @param keyname Name of registry key to open. + @param wr Flag: Open for write access too. + @param erp Error report, may be NULL. + @return Pointer to key handle structure on success, NULL on error. + + Error codes: + - DK4_E_NOT_SUPPORTED<br> + if the function is run on a non-Windows system, + - DK4_E_INVALID_ARGUMENTS<br> + if pk or keyname is invalid, + - DK4_E_NOT_FOUND<br> + if opening or creating the registry key failed, + - DK4_E_MEMORY_ALLOCATION_FAILED<br> + if memory allocation for the key handle structure failed. +*/ +void * +dk4wreg_open_key_c8(int pk, const char *keyname, int wr, dk4_er_t *erp); + +/** Set a string value. + @param kptr Key handle structure. + @param name Entry name. + @param val Entry value. + @param expand Flag: Use REG_EXPAND_SZ (1) or REG_SZ (0). + @param erp Error report, may be NULL. + @return 1 on success, 0 on error. + + Error codes: + - DK4_E_NOT_SUPPORTED<br> + when called on non-Windows systems, + - DK4_E_INVALID_ARGUMENTS<br> + if kptr or val is NULL, + - DK4_E_MATH_OVERFLOW<br> + if the name is too long, + - DK4_E_SYSTEM<br> + if RegSetValueExA() failed. +*/ +int +dk4wreg_set_string_c8( + void *kptr, const char *name, const char *val, int expand, dk4_er_t *erp +); + +/** Get string value. + @param kptr Key handle structure. + @param name Entry name. + @param bptr Buffer for result string. + @param sz Result buffer length. + @param expand Pointer to expand flag output variable. + This variable is set to 1 if the string found + is of type REG_EXPAND_SZ. The variable is left + unchanged for REG_SZ. + @param erp Error report, may be NULL. + @return 1 on success, 0 on error. + + Error codes: + - DK4_E_NOT_SUPPORTED<br> + when called on non-Windows systems, + - DK4_E_INVALID_ARGUMENTS<br> + if kptr, name, or bptr is NULL or sz is 0, + - DK4_E_NOT_FOUND<br> + if the entry is not found or has 0 length, + - DK4_E_SYNTAX<br> + if the entry is not a string type. +*/ +int +dk4wreg_get_string_c8( + void *kptr, + const char *name, + char *bptr, + size_t sz, + int *expand, + dk4_er_t *erp +); + +/** Set DWORD registry entry. + @param kptr Key handle structure. + @param name Entry name. + @param val Value. + @param erp Error report, may be NULL. + @return 1 on success, 0 on error. + + Error codes: + - DK4_E_NOT_SUPPORTED<br> + when called on a non-Windows system, + - DK4_E_INVALID_ARGUMENTS<br> + if kptr is NULL, + - DK4_E_SYSTEM<br> + if RegSetValueExA() failed. +*/ +int +dk4wreg_set_dword_c8( + void *kptr, const char *name, dk4_dword_t val, dk4_er_t *erp +); + +/** Retrieve DWORD value from registry. + @param kptr Key handle structure. + @param name Entry name. + @param vptr Pointer to result variable. + @param erp Error report, may be NULL. + @return 1 on success, 0 on error. +*/ +int +dk4wreg_get_dword_c8( + void *kptr, + const char *name, + dk4_dword_t *vptr, + dk4_er_t *erp +); + +/** Get string value. + @param kptr Key handle structure. + @param name Entry name. + @param dptr Buffer for result string. + @param dsz Result buffer length. + @param b1 First buffer, used for result from RegQueryValue(). + Should have same size as dptr. + @param b1sz Size of b1. + @param b2 Second buffer, used for result from ExpandEnvironmentStrings. + Should be 2 characters larger than dptr. + @param b2sz Size of b2. + @param erp Error report, may be NULL. + @return 1 on success, 0 on error. + + Error codes: + - DK4_E_NOT_SUPPORTED<br> + when called on non-Windows systems, + - DK4_E_INVALID_ARGUMENTS<br> + if kptr, name, dptr, b1 or b2 is NULL or + dsz, b1sz or b2sz is 0 or out of range, + - DK4_E_BUFFER_TOO_SMALL<br> + if one of the buffers is too small, + - DK4_E_NOT_FOUND<br> + if the entry is not found or has 0 length, + - DK4_E_SYNTAX<br> + if the entry is not a string type. +*/ +int +dk4wreg_get_expanded_string_c8( + void *kptr, + const char *name, + char *dptr, + size_t dsz, + char *b1, + size_t b1sz, + char *b2, + size_t b2sz, + dk4_er_t *erp +); + +#ifdef __cplusplus +} +#endif + + +#endif |