:orphan:

.. index:: pair: group; mke2fs tool tapi (tapi_mke2fs)
.. _doxid-group__tapi__mke2fs:

mke2fs tool tapi (tapi_mke2fs)
==============================

.. toctree::
	:hidden:

	struct_tapi_mke2fs_opt.rst

Overview
~~~~~~~~

TAPI to handle mke2fs tool. :ref:`More...<details-group__tapi__mke2fs>`


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

	
	// typedefs

	typedef struct :ref:`tapi_mke2fs_opt<doxid-structtapi__mke2fs__opt>` :ref:`tapi_mke2fs_opt<doxid-group__tapi__mke2fs_1ga10533c2fd27bd2e6074b0168be2098ff>`;
	typedef struct :ref:`tapi_mke2fs_app<doxid-group__tapi__mke2fs_1ga7f53a9cdf338de888840253764eae575>` :ref:`tapi_mke2fs_app<doxid-group__tapi__mke2fs_1ga7f53a9cdf338de888840253764eae575>`;

	// structs

	struct :ref:`tapi_mke2fs_opt<doxid-structtapi__mke2fs__opt>`;

	// global variables

	const :ref:`tapi_mke2fs_opt<doxid-structtapi__mke2fs__opt>` :ref:`tapi_mke2fs_default_opt<doxid-group__tapi__mke2fs_1ga0bbef5e803dbedde3c78688c6070ca54>`;

	// global functions

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_mke2fs_create<doxid-group__tapi__mke2fs_1ga3c1af2a931556f705832bb7b8d9747f5>`(:ref:`tapi_job_factory_t<doxid-group__tapi__job_1ga3379bed0890a0ea0073e2a55f85895cd>`* factory, const :ref:`tapi_mke2fs_opt<doxid-structtapi__mke2fs__opt>`* opt, :ref:`tapi_mke2fs_app<doxid-group__tapi__mke2fs_1ga7f53a9cdf338de888840253764eae575>`** app);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_mke2fs_start<doxid-group__tapi__mke2fs_1ga3eefb246feec66cc31fd77422cc7d29b>`(:ref:`tapi_mke2fs_app<doxid-group__tapi__mke2fs_1ga7f53a9cdf338de888840253764eae575>`* app);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_mke2fs_wait<doxid-group__tapi__mke2fs_1gac1ae0858f26149ed84f2e19f09a8cba7>`(:ref:`tapi_mke2fs_app<doxid-group__tapi__mke2fs_1ga7f53a9cdf338de888840253764eae575>`* app, int timeout_ms);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_mke2fs_kill<doxid-group__tapi__mke2fs_1gae5c398d38ffaedad39b9b86c1a082cea>`(:ref:`tapi_mke2fs_app<doxid-group__tapi__mke2fs_1ga7f53a9cdf338de888840253764eae575>`* app, int signum);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_mke2fs_stop<doxid-group__tapi__mke2fs_1ga97f972d9387cb79949756c7c19898d87>`(:ref:`tapi_mke2fs_app<doxid-group__tapi__mke2fs_1ga7f53a9cdf338de888840253764eae575>`* app);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_mke2fs_destroy<doxid-group__tapi__mke2fs_1gaee5a5688b950c2feb766d0c5aa460a99>`(:ref:`tapi_mke2fs_app<doxid-group__tapi__mke2fs_1ga7f53a9cdf338de888840253764eae575>`* app);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_mke2fs_check_journal<doxid-group__tapi__mke2fs_1gade1a9da342cc3eae15fc7a540b790f46>`(:ref:`tapi_mke2fs_app<doxid-group__tapi__mke2fs_1ga7f53a9cdf338de888840253764eae575>`* app);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_mke2fs_do<doxid-group__tapi__mke2fs_1ga5a43bfa69751354cb5c867db546b5acf>`(:ref:`tapi_job_factory_t<doxid-group__tapi__job_1ga3379bed0890a0ea0073e2a55f85895cd>`* factory, const :ref:`tapi_mke2fs_opt<doxid-structtapi__mke2fs__opt>`* opt, :ref:`tapi_mke2fs_app<doxid-group__tapi__mke2fs_1ga7f53a9cdf338de888840253764eae575>`** app, int timeout_ms);

.. _details-group__tapi__mke2fs:

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

TAPI to handle mke2fs tool.

Copyright (C) 2020-2022 OKTET Labs Ltd. All rights reserved.

Typedefs
--------

.. index:: pair: typedef; tapi_mke2fs_opt
.. _doxid-group__tapi__mke2fs_1ga10533c2fd27bd2e6074b0168be2098ff:

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

	typedef struct :ref:`tapi_mke2fs_opt<doxid-structtapi__mke2fs__opt>` tapi_mke2fs_opt

mke2fs tool specific command line options.

.. index:: pair: typedef; tapi_mke2fs_app
.. _doxid-group__tapi__mke2fs_1ga7f53a9cdf338de888840253764eae575:

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

	typedef struct :ref:`tapi_mke2fs_app<doxid-group__tapi__mke2fs_1ga7f53a9cdf338de888840253764eae575>` tapi_mke2fs_app

mke2fs tool information.

Global Variables
----------------

.. index:: pair: variable; tapi_mke2fs_default_opt
.. _doxid-group__tapi__mke2fs_1ga0bbef5e803dbedde3c78688c6070ca54:

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

	const :ref:`tapi_mke2fs_opt<doxid-structtapi__mke2fs__opt>` tapi_mke2fs_default_opt

Default options initializer.

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

.. index:: pair: function; tapi_mke2fs_create
.. _doxid-group__tapi__mke2fs_1ga3c1af2a931556f705832bb7b8d9747f5:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_mke2fs_create(:ref:`tapi_job_factory_t<doxid-group__tapi__job_1ga3379bed0890a0ea0073e2a55f85895cd>`* factory, const :ref:`tapi_mke2fs_opt<doxid-structtapi__mke2fs__opt>`* opt, :ref:`tapi_mke2fs_app<doxid-group__tapi__mke2fs_1ga7f53a9cdf338de888840253764eae575>`** app)

Create mke2fs app.



.. rubric:: Parameters:

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

	*
		- factory

		- Job factory.

	*
		- opt

		- mke2fs tool options.

	*
		- app

		- mke2fs app handle.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_mke2fs_start
.. _doxid-group__tapi__mke2fs_1ga3eefb246feec66cc31fd77422cc7d29b:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_mke2fs_start(:ref:`tapi_mke2fs_app<doxid-group__tapi__mke2fs_1ga7f53a9cdf338de888840253764eae575>`* app)

Start mke2fs tool.



.. rubric:: Parameters:

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

	*
		- app

		- mke2fs app handle.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_mke2fs_wait
.. _doxid-group__tapi__mke2fs_1gac1ae0858f26149ed84f2e19f09a8cba7:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_mke2fs_wait(:ref:`tapi_mke2fs_app<doxid-group__tapi__mke2fs_1ga7f53a9cdf338de888840253764eae575>`* app, int timeout_ms)

Wait for mke2fs tool completion.



.. rubric:: Parameters:

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

	*
		- app

		- mke2fs app handle.

	*
		- timeout_ms

		- Wait timeout in milliseconds.

	*
		- TE_EINPROGRESS

		- mke2fs is still running.

	*
		- TE_ESHCMD

		- mke2fs was never started or returned non-zero exit status.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_mke2fs_kill
.. _doxid-group__tapi__mke2fs_1gae5c398d38ffaedad39b9b86c1a082cea:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_mke2fs_kill(:ref:`tapi_mke2fs_app<doxid-group__tapi__mke2fs_1ga7f53a9cdf338de888840253764eae575>`* app, int signum)

Send a signal to mke2fs tool.



.. rubric:: Parameters:

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

	*
		- app

		- mke2fs app handle.

	*
		- signum

		- Signal to send.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_mke2fs_stop
.. _doxid-group__tapi__mke2fs_1ga97f972d9387cb79949756c7c19898d87:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_mke2fs_stop(:ref:`tapi_mke2fs_app<doxid-group__tapi__mke2fs_1ga7f53a9cdf338de888840253764eae575>`* app)

Stop mke2fs tool. It can be started over with :ref:`tapi_mke2fs_start() <doxid-group__tapi__mke2fs_1ga3eefb246feec66cc31fd77422cc7d29b>`.



.. rubric:: Parameters:

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

	*
		- app

		- mke2fs app handle.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_mke2fs_destroy
.. _doxid-group__tapi__mke2fs_1gaee5a5688b950c2feb766d0c5aa460a99:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_mke2fs_destroy(:ref:`tapi_mke2fs_app<doxid-group__tapi__mke2fs_1ga7f53a9cdf338de888840253764eae575>`* app)

Destroy mke2fs app. The app cannot be used after calling this function.



.. rubric:: Parameters:

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

	*
		- app

		- mke2fs app handle.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_mke2fs_check_journal
.. _doxid-group__tapi__mke2fs_1gade1a9da342cc3eae15fc7a540b790f46:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_mke2fs_check_journal(:ref:`tapi_mke2fs_app<doxid-group__tapi__mke2fs_1ga7f53a9cdf338de888840253764eae575>`* app)

Check if the filesystem was created with ext3 journal. The function should be called after :ref:`tapi_mke2fs_wait() <doxid-group__tapi__mke2fs_1gac1ae0858f26149ed84f2e19f09a8cba7>`.



.. rubric:: Parameters:

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

	*
		- app

		- mke2fs app handle.

	*
		- 0

		- :ref:`tapi_mke2fs_opt::use_journal <doxid-structtapi__mke2fs__opt_1a6d12048eb577933e37d479faed1cef62>` was not specified or it was specified and the filesystem was created with the journal

	*
		- TE_EPROTO

		- :ref:`tapi_mke2fs_opt::use_journal <doxid-structtapi__mke2fs__opt_1a6d12048eb577933e37d479faed1cef62>` was specified but the journal was not created.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_mke2fs_do
.. _doxid-group__tapi__mke2fs_1ga5a43bfa69751354cb5c867db546b5acf:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_mke2fs_do(:ref:`tapi_job_factory_t<doxid-group__tapi__job_1ga3379bed0890a0ea0073e2a55f85895cd>`* factory, const :ref:`tapi_mke2fs_opt<doxid-structtapi__mke2fs__opt>`* opt, :ref:`tapi_mke2fs_app<doxid-group__tapi__mke2fs_1ga7f53a9cdf338de888840253764eae575>`** app, int timeout_ms)

A convenience wrapper for tapi_mke2fs_create/start/wait.



.. rubric:: Parameters:

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

	*
		- factory

		- Job factory.

	*
		- opt

		- mke2fs tool options.

	*
		- app

		- mke2fs app handle.

	*
		- timeout_ms

		- Wait timeout in milliseconds.



.. rubric:: Returns:

Status code.