#include <a_util/preprocessor/current_function.h>
#include <a_util/result/result_type.h>
#include <a_util/strings/strings_format.h>

Include dependency graph for error_def.h:

This graph shows which files directly or indirectly include this file:

Macros
#define	ERROR_DESCRIPTION(_errcode, ...)

#define	RETURN_ERROR_DESCRIPTION(_errcode, ...)

Detailed Description

Public API for result macros

Copyright

Copyright 2025 Digitalwerk GmbH.

This Source Code Form is subject to the terms of the Mozilla
Public License, v. 2.0. If a copy of the MPL was not distributed
with this file, You can obtain one at https://mozilla.org/MPL/2.0/.

Macro Definition Documentation

◆ ERROR_DESCRIPTION

#define ERROR_DESCRIPTION	(		_errcode,
			... )

Value:

    a_util::result::Result(_errcode,                                                        \
                                  a_util::strings::format(__VA_ARGS__).c_str(),                    \
                                  __LINE__,                                                        \
                                  __FILE__,                                                        \
                                  A_UTIL_CURRENT_FUNCTION)

Return an a_util::result::Result object with detailed error information

The resolved macro instanciates and returns the result object with the error description containing line, file and function name this macro is evaluated from as well as the printf()-like values from the second parameter.

Parameters

[in]	_errcode	The error code to distribute with the result object.
[in]	...	printf()-like arguments creating the error message.

◆ RETURN_ERROR_DESCRIPTION

#define RETURN_ERROR_DESCRIPTION	(		_errcode,
			... )