FS-7352: Document how to use switch_core_set_variable to delete variables

I had to scan through the source of the function to verify that this
is the indeed the actual behaviour, and that NULL is a valid
argument. By mentioning this in the header, we save posterity that
effort.
This commit is contained in:
Manav Rathi 2015-03-06 09:04:10 +05:30
parent c35a23af44
commit 830bc28c45

View File

@ -914,6 +914,7 @@ SWITCH_DECLARE(char *) switch_core_get_domain(switch_bool_t dup);
\brief Add a global variable to the core
\param varname the name of the variable
\param value the value of the variable
\ If \p value is NULL, then \p varname is deleted.
*/
SWITCH_DECLARE(void) switch_core_set_variable(_In_z_ const char *varname, _In_opt_z_ const char *value);
SWITCH_DECLARE(switch_status_t) switch_core_get_variables(switch_event_t **event);