:orphan:

.. index:: pair: group; Command Handler: Variables support
.. _doxid-group__rcf__ch__var:

Command Handler: Variables support
==================================

.. toctree::
	:hidden:

Overview
~~~~~~~~




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

	
	// global functions

	int :ref:`rcf_ch_vread<doxid-group__rcf__ch__var_1ga03691378a76b56ce0c130128d25fba99>`(struct rcf_comm_connection* handle, char* cbuf, size_t buflen, size_t answer_plen, :ref:`rcf_var_type_t<doxid-rcf__common_8h_1aae711149a7b6779e7adc942f79caf013>` type, const char* var);
	int :ref:`rcf_ch_vwrite<doxid-group__rcf__ch__var_1ga042695b962d30c3c8c560405d2ff9aff>`(struct rcf_comm_connection* handle, char* cbuf, size_t buflen, size_t answer_plen, :ref:`rcf_var_type_t<doxid-rcf__common_8h_1aae711149a7b6779e7adc942f79caf013>` type, const char* var, ...);

.. _details-group__rcf__ch__var:

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



Global Functions
----------------

.. index:: pair: function; rcf_ch_vread
.. _doxid-group__rcf__ch__var_1ga03691378a76b56ce0c130128d25fba99:

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

	int rcf_ch_vread(struct rcf_comm_connection* handle, char* cbuf, size_t buflen, size_t answer_plen, :ref:`rcf_var_type_t<doxid-rcf__common_8h_1aae711149a7b6779e7adc942f79caf013>` type, const char* var)

Get value of the variable from the Test Agent or NUT served by it.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- handle

		- connection handle

	*
		- cbuf

		- command buffer

	*
		- buflen

		- length of the command buffer

	*
		- answer_plen

		- number of bytes in the command buffer to be copied to the answer

	*
		- type

		- type of the variable

	*
		- var

		- name of the variable

	*
		- 0

		- command is supported

	*
		- -1

		- command is not supported

	*
		- other

		- error returned by communication library



.. rubric:: Returns:

Indication of command support or error code

.. index:: pair: function; rcf_ch_vwrite
.. _doxid-group__rcf__ch__var_1ga042695b962d30c3c8c560405d2ff9aff:

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

	int rcf_ch_vwrite(struct rcf_comm_connection* handle, char* cbuf, size_t buflen, size_t answer_plen, :ref:`rcf_var_type_t<doxid-rcf__common_8h_1aae711149a7b6779e7adc942f79caf013>` type, const char* var, ...)

Change value of the variable on the Test Agent or NUT served by it.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- handle

		- connection handle

	*
		- cbuf

		- command buffer

	*
		- buflen

		- length of the command buffer

	*
		- answer_plen

		- number of bytes in the command buffer to be copied to the answer

	*
		- type

		- type of the variable

	*
		- var

		- name of the variable

	*
		- ...

		- new value

	*
		- 0

		- command is supported

	*
		- -1

		- command is not supported

	*
		- other

		- error returned by communication library



.. rubric:: Returns:

indication of command support or error code