envz_get(3)

NAME#

envz_add, envz_entry, envz_get, envz_merge, envz_remove, envz_strip - environment string support

LIBRARY#

Standard C library (libc, -lc)

SYNOPSIS#

#include <envz.h>

error_t envz_add(char **restrict \nenvz\n, size_t *restrict \nenvz_len\n,\n
\n               const char *restrict \nname\n, const char *restrict \nvalue\n);

char *envz_entry(const char *restrict \nenvz\n, size_t \nenvz_len\n,\n
\n               const char *restrict \nname\n);

char *envz_get(const char *restrict \nenvz\n, size_t \nenvz_len\n,\n
\n               const char *restrict \nname\n);

error_t envz_merge(char **restrict \nenvz\n, size_t *restrict \nenvz_len\n,\n
\n               const char *restrict \nenvz2\n, size_t \nenvz2_len\n,\n
\n               int \noverride\n);

void envz_remove(char **restrict \nenvz\n, size_t *restrict \nenvz_len\n,\n
\n               const char *restrict \nname\n);

void envz_strip(char **restrict \nenvz\n, size_t *restrict \nenvz_len\n);

DESCRIPTION#

These functions are glibc-specific.

An argz vector is a pointer to a character buffer together with a length, see argz_add(3). An envz vector is a special argz vector, namely one where the strings have the form "name=value". Everything after the first '=' is considered to be the value. If there is no '=', the value is taken to be NULL. (While the value in case of a trailing '=' is the empty string "".)

These functions are for handling envz vectors.

envz_add() adds the string "name=value" (in case value is non-NULL) or "name" (in case value is NULL) to the envz vector (*envz, *envz_len) and updates *envz and *envz_len. If an entry with the same name existed, it is removed.

envz_entry() looks for name in the envz vector (envz, envz_len) and returns the entry if found, or NULL if not.

envz_get() looks for name in the envz vector (envz, envz_len) and returns the value if found, or NULL if not. (Note that the value can also be NULL, namely when there is an entry for name without '=' sign.)

envz_merge() adds each entry in envz2 to *envz, as if with envz_add(). If override is true, then values in envz2 will supersede those with the same name in *envz, otherwise not.

envz_remove() removes the entry for name from (*envz, *envz_len) if there was one.

envz_strip() removes all entries with value NULL.

RETURN VALUE#

All envz functions that do memory allocation have a return type of error_t (an integer type), and return 0 for success, and ENOMEM if an allocation error occurs.

ATTRIBUTES#

For an explanation of the terms used in this section, see attributes(7).

STANDARDS#

GNU.

EXAMPLES#

#include <envz.h>
#include <stdio.h>
#include <stdlib.h>
int
main(int argc, char *argv[], char *envp[])
{
\n
    char    *str;
\n
    size_t  e_len = 0;
\n
    for (size_t i = 0; envp[i] != NULL; i++)
\n
        e_len += strlen(envp[i]) + 1;
\n
    str = envz_entry(*envp, e_len, "HOME");
\n
    printf("%s\n", str);
\n
    str = envz_get(*envp, e_len, "HOME");
\n
    printf("%s\n", str);
\n
    exit(EXIT_SUCCESS);
}

SEE ALSO#

argz_add(3)