error_def.h File Reference

Public API for result macros. More...

Go to the source code of this file.

Macros
#define	RETURN_ERROR_DESCRIPTION(_errcode, ...)
	Return an a_util::result::Result object with detailed error information. More...

Detailed Description

Public API for result macros.

Copyright

Copyright @ 2021 VW Group. All rights reserved.

    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/.

If it is not possible or desirable to put the notice in a particular file, then
You may include the notice in a location (such as a LICENSE file in a
relevant directory) where a recipient would be likely to look for such a notice.

You may add additional accurate notices of copyright ownership.

Definition in file error_def.h.

Macro Definition Documentation

RETURN_ERROR_DESCRIPTION

#define RETURN_ERROR_DESCRIPTION	(		_errcode,
			...
	)

Value:

    return 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.

Definition at line 36 of file error_def.h.