:orphan:

.. index:: pair: struct; cfg_register_msg
.. _doxid-structcfg__register__msg:

struct cfg_register_msg
=======================

.. toctree::
	:hidden:

Overview
~~~~~~~~

CFG_REGISTER message content :ref:`More...<details-structcfg__register__msg>`


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

	#include <conf_messages.h>
	
	struct cfg_register_msg {
		// fields
	
		:ref:`CFG_MSG_FIELDS<doxid-conf__messages_8h_1a6eaa8ca68dc59991824da18891a37139>` :ref:`cfg_val_type<doxid-conf__types_8h_1a21c9ece7b60181bc9e8ae7a04060e872>` :ref:`val_type<doxid-structcfg__register__msg_1a239970a44be087b8b702dc6fba0c0474>`;
		bool :ref:`vol<doxid-structcfg__register__msg_1a7b17f9aed2c41b47cc2bbdd260bb78f0>`;
		bool :ref:`no_parent_dep<doxid-structcfg__register__msg_1ad6e536810eaa725badb22248834fc1b7>`;
		bool :ref:`substitution<doxid-structcfg__register__msg_1a4eaa4fabb4e6a8ed2ae31c13fe44f3c9>`;
		bool :ref:`unit<doxid-structcfg__register__msg_1af0a8da686276df3ed2f83777f6fe192f>`;
		uint8_t :ref:`access<doxid-structcfg__register__msg_1a300b92e9128ea2d9db2ffc703a86f6ed>`;
		uint16_t :ref:`def_val<doxid-structcfg__register__msg_1aabe3f334b5c0a744dacc19a5eeb075d4>`;
		:ref:`cfg_handle<doxid-group__confapi__base_1gabc299401ba5bcc0edb6eab462c0a6ba4>` :ref:`handle<doxid-structcfg__register__msg_1a99abbf44d020aa371119eee531dbf01f>`;
		char :ref:`oid<doxid-structcfg__register__msg_1a71fa7a9babd48a0b2a0ca3e100037e5b>`[0];
	};
.. _details-structcfg__register__msg:

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

CFG_REGISTER message content

Fields
------

.. index:: pair: variable; val_type
.. _doxid-structcfg__register__msg_1a239970a44be087b8b702dc6fba0c0474:

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

	:ref:`CFG_MSG_FIELDS<doxid-conf__messages_8h_1a6eaa8ca68dc59991824da18891a37139>` :ref:`cfg_val_type<doxid-conf__types_8h_1a21c9ece7b60181bc9e8ae7a04060e872>` val_type

Type of the object instance value

.. index:: pair: variable; vol
.. _doxid-structcfg__register__msg_1a7b17f9aed2c41b47cc2bbdd260bb78f0:

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

	bool vol

Object is volatile

.. index:: pair: variable; no_parent_dep
.. _doxid-structcfg__register__msg_1ad6e536810eaa725badb22248834fc1b7:

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

	bool no_parent_dep

Object should not depend on parent

.. index:: pair: variable; substitution
.. _doxid-structcfg__register__msg_1a4eaa4fabb4e6a8ed2ae31c13fe44f3c9:

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

	bool substitution

The object uses substitution

.. index:: pair: variable; unit
.. _doxid-structcfg__register__msg_1af0a8da686276df3ed2f83777f6fe192f:

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

	bool unit

The object is a single logical unit, its descendants are properties of that unit

.. index:: pair: variable; access
.. _doxid-structcfg__register__msg_1a300b92e9128ea2d9db2ffc703a86f6ed:

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

	uint8_t access

Access rights

.. index:: pair: variable; def_val
.. _doxid-structcfg__register__msg_1aabe3f334b5c0a744dacc19a5eeb075d4:

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

	uint16_t def_val

Default value offset from start of OID or 0 if no default value is provided

.. index:: pair: variable; handle
.. _doxid-structcfg__register__msg_1a99abbf44d020aa371119eee531dbf01f:

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

	:ref:`cfg_handle<doxid-group__confapi__base_1gabc299401ba5bcc0edb6eab462c0a6ba4>` handle

OUT: handle of created object object identifier

.. index:: pair: variable; oid
.. _doxid-structcfg__register__msg_1a71fa7a9babd48a0b2a0ca3e100037e5b:

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

	char oid[0]

IN: start of the object identifier