Module eenv

Function Index
Function Details

Function Index

get/2	Returns the value of configuration parameter Par for Application.
get/3	Works like `get/2` but Returns value Default when configuration parameter Par does not exist.
load/1	Loads the application configuration for an application into the beam.
set/2	Works like `set/3`.
set/3	Sets the value of configuration parameter Par for Application.
set/4	Sets the value of configuration parameter Par for Application.
unload/1	Deletes the application configuration beam file.
unset/2	Removes the configuration parameter Par and its value for Application.
unset/3	Removes the configuration parameter Par and its value for Application.

Function Details

get/2

get(Application, Par) -> undefined | unloaded | {ok, Val}

Application = atom()
Par = atom()
Val = term()

Returns the value of configuration parameter Par for Application. Returns undefined if the configuration parameter does not exist: Returns unloaded if application is not loaded by eenv.

get/3

get(Application, Par, Default) -> Val

Application = atom()
Par = atom()
Default = term()
Val = term()

Works like get/2 but Returns value Default when configuration parameter Par does not exist. Returns application:get_env(App, Par, Default) when application is not loaded by eenv.

load/1

load(Applications) -> ok

Applications = atom() | [atom()]

Loads the application configuration for an application into the beam.

set/2

set(Application, List) -> ok

Application = atom()
List = [{atom(), term()}]

Works like set/3. with setting in batches.

set/3

set(Application, Par, Val) -> ok

Application = atom()
Par = atom()
Val = term()

Sets the value of configuration parameter Par for Application. Same as application:get_env/3. Use this function only if you know what you are doing, that is, on your own applications. It is very application-dependent and configuration parameter-dependent when and how often the value is read by the application. Careless use of this function can put the application in a weird, inconsistent, and malfunctioning state.

set/4

set(Application, Par, Val, Opt) -> ok

Application = atom()
Par = atom()
Opt = [{timeout, timeout()} | {persistent, boolean()}]
Val = term()

Sets the value of configuration parameter Par for Application. Same as application:set_env/4.

unload/1

unload(App) -> any()

Deletes the application configuration beam file.

unset/2

unset(Application, Pars) -> ok

Application = atom()
Pars = atom() | [atom()]

Removes the configuration parameter Par and its value for Application. Same as application:unset_env(Application, Par).

unset/3

unset(Application, Pars, Opt) -> ok

Application = atom()
Opt = [{timeout, timeout()} | {persistent, boolean()}]
Pars = atom() | [atom()]

Removes the configuration parameter Par and its value for Application. Same as application:unset_env(Application, Par, Opt).

Generated by EDoc