:orphan:

.. index:: pair: group; TAPI for directory operation calls
.. _doxid-group__te__lib__rpc__dirent:

TAPI for directory operation calls
==================================

.. toctree::
	:hidden:

	struct_rpc_dirent.rst

Overview
~~~~~~~~




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

	
	// typedefs

	typedef rpc_ptr :ref:`rpc_dir_p<doxid-group__te__lib__rpc__dirent_1gaef3d81726540fc5fd892ff42d5b6d9a7>`;
	typedef struct :ref:`rpc_dirent<doxid-structrpc__dirent>` :ref:`rpc_dirent<doxid-group__te__lib__rpc__dirent_1ga881d29714f50634fc600a6654caae2d5>`;

	// structs

	struct :ref:`rpc_dirent<doxid-structrpc__dirent>`;

	// global functions

	void :ref:`rpc_struct_dirent_props<doxid-group__te__lib__rpc__dirent_1ga56681afaa4db4b8d1c4a2baf0c8b3b56>`(:ref:`rcf_rpc_server<doxid-structrcf__rpc__server>`* rpcs, size_t* props);
	:ref:`rpc_dir_p<doxid-group__te__lib__rpc__dirent_1gaef3d81726540fc5fd892ff42d5b6d9a7>` :ref:`rpc_opendir<doxid-group__te__lib__rpc__dirent_1ga89305b425db683dc7b66464ba7ce5a49>`(:ref:`rcf_rpc_server<doxid-structrcf__rpc__server>`* rpcs, const char* path);
	int :ref:`rpc_closedir<doxid-group__te__lib__rpc__dirent_1gad5982e828d645968d6dfec8b0f83d845>`(:ref:`rcf_rpc_server<doxid-structrcf__rpc__server>`* rpcs, :ref:`rpc_dir_p<doxid-group__te__lib__rpc__dirent_1gaef3d81726540fc5fd892ff42d5b6d9a7>` dirp);
	:ref:`rpc_dirent<doxid-structrpc__dirent>`* :ref:`rpc_readdir<doxid-group__te__lib__rpc__dirent_1ga7dae9bd0790d7a07d51dcfa730cbea87>`(:ref:`rcf_rpc_server<doxid-structrcf__rpc__server>`* rpcs, :ref:`rpc_dir_p<doxid-group__te__lib__rpc__dirent_1gaef3d81726540fc5fd892ff42d5b6d9a7>` dirp);

.. _details-group__te__lib__rpc__dirent:

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



Typedefs
--------

.. index:: pair: typedef; rpc_dir_p
.. _doxid-group__te__lib__rpc__dirent_1gaef3d81726540fc5fd892ff42d5b6d9a7:

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

	typedef rpc_ptr rpc_dir_p

'DIR \*' equivalent

.. index:: pair: typedef; rpc_dirent
.. _doxid-group__te__lib__rpc__dirent_1ga881d29714f50634fc600a6654caae2d5:

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

	typedef struct :ref:`rpc_dirent<doxid-structrpc__dirent>` rpc_dirent

'struct dirent' equivalent

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

.. index:: pair: function; rpc_struct_dirent_props
.. _doxid-group__te__lib__rpc__dirent_1ga56681afaa4db4b8d1c4a2baf0c8b3b56:

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

	void rpc_struct_dirent_props(:ref:`rcf_rpc_server<doxid-structrcf__rpc__server>`* rpcs, size_t* props)

Get properties of 'struct dirent' on target system (mainly information on which fields exist in 'struct dirent').



.. rubric:: Parameters:

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

	*
		- rpcs

		- RPC server handle

	*
		- props

		- properties of 'struct dirent' (OUT)



.. rubric:: Returns:

N/A

.. index:: pair: function; rpc_opendir
.. _doxid-group__te__lib__rpc__dirent_1ga89305b425db683dc7b66464ba7ce5a49:

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

	:ref:`rpc_dir_p<doxid-group__te__lib__rpc__dirent_1gaef3d81726540fc5fd892ff42d5b6d9a7>` rpc_opendir(:ref:`rcf_rpc_server<doxid-structrcf__rpc__server>`* rpcs, const char* path)

Open a directory stream.



.. rubric:: Parameters:

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

	*
		- rpcs

		- RPC server handle

	*
		- path

		- Path to a directory



.. rubric:: Returns:

A pointer to the directory stream or NULL on failure

.. index:: pair: function; rpc_closedir
.. _doxid-group__te__lib__rpc__dirent_1gad5982e828d645968d6dfec8b0f83d845:

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

	int rpc_closedir(:ref:`rcf_rpc_server<doxid-structrcf__rpc__server>`* rpcs, :ref:`rpc_dir_p<doxid-group__te__lib__rpc__dirent_1gaef3d81726540fc5fd892ff42d5b6d9a7>` dirp)

Close a directory stream.



.. rubric:: Parameters:

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

	*
		- rpcs

		- RPC server handle

	*
		- dirp

		- Directory stream to close



.. rubric:: Returns:

0 on success or -1 on failure

.. index:: pair: function; rpc_readdir
.. _doxid-group__te__lib__rpc__dirent_1ga7dae9bd0790d7a07d51dcfa730cbea87:

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

	:ref:`rpc_dirent<doxid-structrpc__dirent>`* rpc_readdir(:ref:`rcf_rpc_server<doxid-structrcf__rpc__server>`* rpcs, :ref:`rpc_dir_p<doxid-group__te__lib__rpc__dirent_1gaef3d81726540fc5fd892ff42d5b6d9a7>` dirp)

Read next directory entry from a directory stream.



.. rubric:: Parameters:

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

	*
		- rpcs

		- RPC server handle

	*
		- dirp

		- Directory stream handle



.. rubric:: Returns:

A pointer to dirent structure or NULL if the end of the directory stream reached or an error occurred