diff options
Diffstat (limited to 'include/libfud.hpp')
| -rw-r--r-- | include/libfud.hpp | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/include/libfud.hpp b/include/libfud.hpp index 1e6df5d..271d55b 100644 --- a/include/libfud.hpp +++ b/include/libfud.hpp @@ -27,6 +27,15 @@ namespace fud { /** \brief Fear, unknown, doubt. Call at your own peril. */ void fud(); +/** + * \brief Get an environmental variable if it exists. + * + * \param[in] name The name of the variable to look up. + * + * \retstmt The value of the string bound to the variable if it exists. + * \retcode FudStatus::NullPointer if name is a null pointer. + * \retcode FudStatus::NotFound if no binding for the variable exists. + */ Result<String, FudStatus> getEnv(const char* name); template<typename T> |