summaryrefslogtreecommitdiff
path: root/include/util/env.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/util/env.h')
-rw-r--r--include/util/env.h14
1 files changed, 13 insertions, 1 deletions
diff --git a/include/util/env.h b/include/util/env.h
index 6720fa8..e271f4b 100644
--- a/include/util/env.h
+++ b/include/util/env.h
@@ -4,8 +4,20 @@
#include <stdbool.h>
#include <unistd.h>
+/**
+ * Parse a bool from an environment variable.
+ *
+ * On success, the parsed value is returned. On error, false is returned.
+ */
bool env_parse_bool(const char *option);
-ssize_t env_parse_switch(const char *option, const char **switches);
+/**
+ * Pick a choice from an environment variable.
+ *
+ * On success, the choice index is returned. On error, zero is returned.
+ *
+ * switches is a NULL-terminated array.
+ */
+size_t env_parse_switch(const char *option, const char **switches);
#endif