:orphan:

.. index:: pair: group; Command Handler: File manipulation support
.. _doxid-group__rcf__ch__file:

Command Handler: File manipulation support
==========================================

.. toctree::
	:hidden:

Overview
~~~~~~~~




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

	
	// global functions

	int :ref:`rcf_ch_file<doxid-group__rcf__ch__file_1gabe3194c6d1f94312e388a448de576e16>`(struct rcf_comm_connection* handle, char* cbuf, size_t buflen, size_t answer_plen, const uint8_t* ba, size_t cmdlen, :ref:`rcf_op_t<doxid-rcf__internal_8h_1ad391371ee9b7f40edae7b6f44e45be1b>` op, const char* filename);

.. _details-group__rcf__ch__file:

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



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

.. index:: pair: function; rcf_ch_file
.. _doxid-group__rcf__ch__file_1gabe3194c6d1f94312e388a448de576e16:

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

	int rcf_ch_file(struct rcf_comm_connection* handle, char* cbuf, size_t buflen, size_t answer_plen, const uint8_t* ba, size_t cmdlen, :ref:`rcf_op_t<doxid-rcf__internal_8h_1ad391371ee9b7f40edae7b6f44e45be1b>` op, const char* filename)

Put/get file to/from the Test Agent or NUT served by it. If the function returns -1, default command processing (using stdio library) is performed by caller.



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

	*
		- ba

		- pointer to location of binary attachment in the command buffer or NULL if no binary attachment is provided

	*
		- cmdlen

		- full length of the command including binary attachment

	*
		- op

		- RCFOP_FGET, RCFOP_FPUT or RCFOP_FDEL

	*
		- filename

		- full name of the file in TA or NUT file system

	*
		- 0

		- command is supported

	*
		- -1

		- command is not supported

	*
		- other

		- error returned by communication library



.. rubric:: Returns:

Indication of command support or error code