:orphan:

.. index:: pair: enum; read_message_rc
.. _doxid-common_8h_1aa407834cf33d768e50cb780009b77028:

enum read_message_rc
====================

Overview
~~~~~~~~

Message reading result code :ref:`More...<details-common_8h_1aa407834cf33d768e50cb780009b77028>`

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

	#include <common.h>

	enum read_message_rc {
	    :ref:`READ_MESSAGE_RC_ERR<doxid-common_8h_1aa407834cf33d768e50cb780009b77028aff54be770bf27ac2b97987432cf4cfc5>`       = -2,
	    :ref:`READ_MESSAGE_RC_WRONG_VER<doxid-common_8h_1aa407834cf33d768e50cb780009b77028a986beb598d73740859c4df3bf7e6d10a>` = -1,
	    :ref:`READ_MESSAGE_RC_EOF<doxid-common_8h_1aa407834cf33d768e50cb780009b77028a55f05478c9bb75172170d5eafe745f06>`       = 0,
	    :ref:`READ_MESSAGE_RC_OK<doxid-common_8h_1aa407834cf33d768e50cb780009b77028a2bcce32dade73b88a268c28d11f49fa9>`        = 1,
	};

.. _details-common_8h_1aa407834cf33d768e50cb780009b77028:

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

Message reading result code

Enum Values
-----------

.. index:: pair: enumvalue; READ_MESSAGE_RC_ERR
.. _doxid-common_8h_1aa407834cf33d768e50cb780009b77028aff54be770bf27ac2b97987432cf4cfc5:

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

	READ_MESSAGE_RC_ERR

A reading error occurred or unexpected EOF was reached

.. index:: pair: enumvalue; READ_MESSAGE_RC_WRONG_VER
.. _doxid-common_8h_1aa407834cf33d768e50cb780009b77028a986beb598d73740859c4df3bf7e6d10a:

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

	READ_MESSAGE_RC_WRONG_VER

A message of unsupported version was encountered

.. index:: pair: enumvalue; READ_MESSAGE_RC_EOF
.. _doxid-common_8h_1aa407834cf33d768e50cb780009b77028a55f05478c9bb75172170d5eafe745f06:

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

	READ_MESSAGE_RC_EOF

The EOF was encountered instead of the message

.. index:: pair: enumvalue; READ_MESSAGE_RC_OK
.. _doxid-common_8h_1aa407834cf33d768e50cb780009b77028a2bcce32dade73b88a268c28d11f49fa9:

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

	READ_MESSAGE_RC_OK

The message was read successfully