diff options
Diffstat (limited to 'include/asterisk/json.h')
| -rw-r--r-- | include/asterisk/json.h | 18 |
1 files changed, 14 insertions, 4 deletions
diff --git a/include/asterisk/json.h b/include/asterisk/json.h index 8cb74a459..28ebfbd51 100644 --- a/include/asterisk/json.h +++ b/include/asterisk/json.h @@ -1010,13 +1010,24 @@ struct ast_party_id; */ struct ast_json *ast_json_party_id(struct ast_party_id *party); +enum ast_json_to_ast_vars_code { + /*! \brief Conversion successful */ + AST_JSON_TO_AST_VARS_CODE_SUCCESS, + /*! + * \brief Conversion failed because invalid value type supplied. + * \note Only string values allowed. + */ + AST_JSON_TO_AST_VARS_CODE_INVALID_TYPE, + /*! \brief Conversion failed because of allocation failure. (Out Of Memory) */ + AST_JSON_TO_AST_VARS_CODE_OOM, +}; + /*! * \brief Convert a \c ast_json list of key/value pair tuples into a \c ast_variable list * \since 12.5.0 * * \param json_variables The JSON blob containing the variable * \param variables An out reference to the variables to populate. - * The pointer to the variables should be NULL when calling this. * * \code * struct ast_json *json_variables = ast_json_pack("[ { s: s } ]", "foo", "bar"); @@ -1026,10 +1037,9 @@ struct ast_json *ast_json_party_id(struct ast_party_id *party); * res = ast_json_to_ast_variables(json_variables, &variables); * \endcode * - * \retval 0 success - * \retval -1 error + * \return Conversion enum ast_json_to_ast_vars_code status */ -int ast_json_to_ast_variables(struct ast_json *json_variables, struct ast_variable **variables); +enum ast_json_to_ast_vars_code ast_json_to_ast_variables(struct ast_json *json_variables, struct ast_variable **variables); /*!@}*/ |