:orphan:

.. index:: pair: group; Command Handler: Function call support
.. _doxid-group__rcf__ch__func:

Command Handler: Function call support
======================================

.. toctree::
	:hidden:

Overview
~~~~~~~~




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

	
	// global functions

	int :ref:`rcf_ch_call<doxid-group__rcf__ch__func_1ga4feeb1509b8589f6d570756f928865f9>`(struct rcf_comm_connection* handle, char* cbuf, size_t buflen, size_t answer_plen, const char* rtn, bool is_argv, int argc, void** params);

.. _details-group__rcf__ch__func:

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



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

.. index:: pair: function; rcf_ch_call
.. _doxid-group__rcf__ch__func_1ga4feeb1509b8589f6d570756f928865f9:

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

	int rcf_ch_call(struct rcf_comm_connection* handle, char* cbuf, size_t buflen, size_t answer_plen, const char* rtn, bool is_argv, int argc, void** params)

Execute routine on the Test Agent or NUT served by it. Parameters of the function are not parsed. If the handler returns -1, then default processing is performed by caller: Portable Commands Handler obtains address of the function using :ref:`rcf_ch_symbol_addr() <doxid-group__rcf__ch__addr_1gac34f3d1f418a10609c595a3a0eff8423>`, calls a routine rcf_ch_call_routine() to execute the routine and sends an answer.



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

	*
		- rtn

		- routine name

	*
		- is_argv

		- if ``true``, then routine prototype is (int argc, char \*\*argv)

	*
		- argc

		- number of arguments

	*
		- params

		- pointer to array of RCF_MAX_PARAMS length with routine arguments

	*
		- 0

		- command is supported

	*
		- -1

		- command is not supported

	*
		- other

		- error returned by communication library



.. rubric:: Returns:

Indication of command support or error code