Mercurial > dovecot > core-2.2

annotate src/lib/env-util.h @ 23007:36e01285b5b8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
lib: buffer - Improve header comment for buffer_insert() and buffer_delete().
author Stephan Bosch <stephan.bosch@dovecot.fi>
date Mon, 18 Mar 2019 00:52:37 +0100
parents e60061623012
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6410
e4eb71ae8e96 Changed .h ifdef/defines to use <NAME>_H format.
Timo Sirainen <tss@iki.fi>
parents: 1271
diff changeset
1 #ifndef ENV_UTIL_H
e4eb71ae8e96 Changed .h ifdef/defines to use <NAME>_H format.
Timo Sirainen <tss@iki.fi>
parents: 1271
diff changeset
2 #define ENV_UTIL_H
697
7814b29d0862 Created env_put() and env_clean() for a bit easier handling of environment
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
3
7814b29d0862 Created env_put() and env_clean() for a bit easier handling of environment
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
4 /* Add new environment variable. Wrapper to putenv(). Note that calls to this
7814b29d0862 Created env_put() and env_clean() for a bit easier handling of environment
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
5 function allocates memory which isn't free'd until env_clean() is called. */
7814b29d0862 Created env_put() and env_clean() for a bit easier handling of environment
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
6 void env_put(const char *env);
8536
b1a7df02ba38 Added env_remove().
Timo Sirainen <tss@iki.fi>
parents: 7109
diff changeset
7 /* Remove a single environment. */
b1a7df02ba38 Added env_remove().
Timo Sirainen <tss@iki.fi>
parents: 7109
diff changeset
8 void env_remove(const char *name);
697
7814b29d0862 Created env_put() and env_clean() for a bit easier handling of environment
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
9 /* Clear all environment variables. */
7814b29d0862 Created env_put() and env_clean() for a bit easier handling of environment
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
10 void env_clean(void);
12347
fe72469ccdf5 Added env_clean_except()
Timo Sirainen <tss@iki.fi>
parents: 9712
diff changeset
11 /* Clear all environment variables except what's listed in preserve_envs[] */
fe72469ccdf5 Added env_clean_except()
Timo Sirainen <tss@iki.fi>
parents: 9712
diff changeset
12 void env_clean_except(const char *const preserve_envs[]);
697
7814b29d0862 Created env_put() and env_clean() for a bit easier handling of environment
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
13
9320
9bdd43acd083 Added env_backup_*() for saving/restoring environment.
Timo Sirainen <tss@iki.fi>
parents: 8536
diff changeset
14 /* Save a copy of the current environment. */
9bdd43acd083 Added env_backup_*() for saving/restoring environment.
Timo Sirainen <tss@iki.fi>
parents: 8536
diff changeset
15 struct env_backup *env_backup_save(void);
9bdd43acd083 Added env_backup_*() for saving/restoring environment.
Timo Sirainen <tss@iki.fi>
parents: 8536
diff changeset
16 /* Clear the current environment and restore the backup. */
9bdd43acd083 Added env_backup_*() for saving/restoring environment.
Timo Sirainen <tss@iki.fi>
parents: 8536
diff changeset
17 void env_backup_restore(struct env_backup *env);
9bdd43acd083 Added env_backup_*() for saving/restoring environment.
Timo Sirainen <tss@iki.fi>
parents: 8536
diff changeset
18 /* Free the memory used by environment backup. */
9bdd43acd083 Added env_backup_*() for saving/restoring environment.
Timo Sirainen <tss@iki.fi>
parents: 8536
diff changeset
19 void env_backup_free(struct env_backup **env);
9bdd43acd083 Added env_backup_*() for saving/restoring environment.
Timo Sirainen <tss@iki.fi>
parents: 8536
diff changeset
20
12412
e60061623012 Added env_get_environ_p() as more portable way of accessing environ variable.
Timo Sirainen <tss@iki.fi>
parents: 12347
diff changeset
21 /* Returns the value of "&environ". This is more portable than using it
e60061623012 Added env_get_environ_p() as more portable way of accessing environ variable.
Timo Sirainen <tss@iki.fi>
parents: 12347
diff changeset
22 directly. */
e60061623012 Added env_get_environ_p() as more portable way of accessing environ variable.
Timo Sirainen <tss@iki.fi>
parents: 12347
diff changeset
23 char ***env_get_environ_p(void);
e60061623012 Added env_get_environ_p() as more portable way of accessing environ variable.
Timo Sirainen <tss@iki.fi>
parents: 12347
diff changeset
24
9712
d48c8c0c1d29 lib_deinit() now frees memory used by env_put().
Timo Sirainen <tss@iki.fi>
parents: 9320
diff changeset
25 /* Free all memory used by env_put() function. Environment must not be
d48c8c0c1d29 lib_deinit() now frees memory used by env_put().
Timo Sirainen <tss@iki.fi>
parents: 9320
diff changeset
26 accessed afterwards. */
d48c8c0c1d29 lib_deinit() now frees memory used by env_put().
Timo Sirainen <tss@iki.fi>
parents: 9320
diff changeset
27 void env_deinit(void);
d48c8c0c1d29 lib_deinit() now frees memory used by env_put().
Timo Sirainen <tss@iki.fi>
parents: 9320
diff changeset
28
697
7814b29d0862 Created env_put() and env_clean() for a bit easier handling of environment
Timo Sirainen <tss@iki.fi>
parents:
diff changeset
29 #endif