421 |
mateuszvis |
1 |
/* This file is part of the SvarCOM project and is published under the terms
|
|
|
2 |
* of the MIT license.
|
|
|
3 |
*
|
1731 |
mateusz.vi |
4 |
* Copyright (C) 2021-2024 Mateusz Viste
|
421 |
mateuszvis |
5 |
*
|
|
|
6 |
* Permission is hereby granted, free of charge, to any person obtaining a
|
|
|
7 |
* copy of this software and associated documentation files (the "Software"),
|
|
|
8 |
* to deal in the Software without restriction, including without limitation
|
|
|
9 |
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
|
|
10 |
* and/or sell copies of the Software, and to permit persons to whom the
|
|
|
11 |
* Software is furnished to do so, subject to the following conditions:
|
|
|
12 |
*
|
|
|
13 |
* The above copyright notice and this permission notice shall be included in
|
|
|
14 |
* all copies or substantial portions of the Software.
|
|
|
15 |
*
|
|
|
16 |
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
|
17 |
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
|
18 |
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
|
19 |
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
|
20 |
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
|
21 |
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
|
|
22 |
* DEALINGS IN THE SOFTWARE.
|
|
|
23 |
*/
|
|
|
24 |
|
361 |
mateuszvis |
25 |
/*
|
|
|
26 |
* routines used to manipulate the environment block
|
|
|
27 |
*/
|
|
|
28 |
|
|
|
29 |
#ifndef ENV_H
|
|
|
30 |
#define ENV_H
|
|
|
31 |
|
|
|
32 |
/* looks for varname in environment block and returns a far ptr to it if
|
|
|
33 |
* found, NULL otherwise. varname MUST be in upper-case and MUST be terminated
|
|
|
34 |
* by either a = sign or a NULL terminator */
|
|
|
35 |
char far *env_lookup(unsigned short env_seg, const char *varname);
|
|
|
36 |
|
436 |
mateuszvis |
37 |
/* almost identical to env_lookup(), but instead of returning a pointer
|
|
|
38 |
* to the 'NAME=value' string, it returns a pointer to value (or NULL if
|
|
|
39 |
* var not found) */
|
|
|
40 |
char far *env_lookup_val(unsigned short env_seg, const char *varname);
|
|
|
41 |
|
570 |
mateuszvis |
42 |
/* locates the value of env variable varname and copies it to result, up to
|
|
|
43 |
* ressz bytes (incl. the NULL terminator). returns the length of the value on
|
|
|
44 |
* success, 0 if var not found or couldn't fit in ressz). */
|
|
|
45 |
unsigned short env_lookup_valcopy(char *res, unsigned short ressz, unsigned short env_seg, const char *varname);
|
|
|
46 |
|
361 |
mateuszvis |
47 |
/* returns the size, in bytes, of the allocated environment block */
|
|
|
48 |
unsigned short env_allocsz(unsigned short env_seg);
|
|
|
49 |
|
1731 |
mateusz.vi |
50 |
/* return currently used space (length, in bytes) of the environment */
|
|
|
51 |
unsigned short env_getcurlen(unsigned short env_seg);
|
|
|
52 |
|
361 |
mateuszvis |
53 |
/* remove a variable from environment, if present. returns 0 on success, non-zero if variable not found */
|
|
|
54 |
int env_dropvar(unsigned short env_seg, const char *varname);
|
|
|
55 |
|
|
|
56 |
#define ENV_SUCCESS 0
|
|
|
57 |
#define ENV_NOTENOM -1
|
|
|
58 |
#define ENV_INVSYNT -2
|
|
|
59 |
|
|
|
60 |
/* Writes a variable to environment block. The variable must in the form
|
|
|
61 |
* "varname=value". If variable is already present in the environment block,
|
|
|
62 |
* then the value will be updated. If the new value is empty, then the
|
|
|
63 |
* existing variable (if any) is removed.
|
|
|
64 |
*
|
|
|
65 |
* This function returns:
|
|
|
66 |
* ENV_SUCCESS = success
|
|
|
67 |
* ENV_NOTENOM = not enough available space in memory block
|
|
|
68 |
* ENV_INVSYNT = invalid syntax
|
|
|
69 |
*/
|
|
|
70 |
int env_setvar(unsigned short env_seg, const char *v);
|
|
|
71 |
|
|
|
72 |
#endif
|