:orphan:

.. index:: pair: struct; tapi_test_expected_result
.. _doxid-structtapi__test__expected__result:

struct tapi_test_expected_result
================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

The description of an expected result. :ref:`More...<details-structtapi__test__expected__result>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <tapi_test.h>
	
	struct tapi_test_expected_result {
		// fields
	
		:ref:`te_module<doxid-te__errno_8h_1a26e5ef45586b9965282bb27a07ec85b7>` :ref:`error_module<doxid-structtapi__test__expected__result_1a96573479fdce7fa1aceb651409676a9f>`;
		:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`error_code<doxid-structtapi__test__expected__result_1a006a67ce9c9924ac2495e45892e68a54>`;
		const char* :ref:`output<doxid-structtapi__test__expected__result_1a08f224a3e51bfa50a394e1b2c0b2d1bd>`;
	};
.. _details-structtapi__test__expected__result:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

The description of an expected result.

The structure should be considered opaque and only handled by dedicated functions such as :ref:`test_get_expected_result_param() <doxid-group__te__ts__tapi__test__param_1gac2ec22f3271a0f17faf26b6008d98f52>`, :ref:`TEST_EXPECTED_RESULT_PARAM() <doxid-group__te__ts__tapi__test__param_1ga64a23c6ae5f791b5c594d9c427b37b71>`, :ref:`TEST_GET_EXPECTED_RESULT_PARAM() <doxid-group__te__ts__tapi__test__param_1ga43a9b6ccbd1c0283bdf5c881ccae6b50>`, :ref:`tapi_test_check_expected_result() <doxid-group__te__ts__tapi__test__param_1ga6b8e4bbeb9bcbe082b1128cb183852e1>`, :ref:`tapi_test_check_expected_int_result() <doxid-group__te__ts__tapi__test__param_1ga6581850476487c5293f709bf8b951ba3>`.

The values of this type may be freely copied, they do not contain any dynamically-allocated resources.

Fields
------

.. index:: pair: variable; error_module
.. _doxid-structtapi__test__expected__result_1a96573479fdce7fa1aceb651409676a9f:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_module<doxid-te__errno_8h_1a26e5ef45586b9965282bb27a07ec85b7>` error_module

The expected module code.

TE_MIN_MODULE means any module.

.. index:: pair: variable; error_code
.. _doxid-structtapi__test__expected__result_1a006a67ce9c9924ac2495e45892e68a54:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` error_code

The expected error code (without a module).

.. index:: pair: variable; output
.. _doxid-structtapi__test__expected__result_1a08f224a3e51bfa50a394e1b2c0b2d1bd:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const char* output

The expected output string.