:orphan:

.. index:: pair: struct; iscsi_target_param_descr_t
.. _doxid-structiscsi__target__param__descr__t:

struct iscsi_target_param_descr_t
=================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Generic parameter description for :ref:`iscsi_write_param() <doxid-iscsi__initiator_8h_1a5de715c02988035c8120106f7c3f4a38>` :ref:`More...<details-structiscsi__target__param__descr__t>`


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

	#include <iscsi_initiator.h>
	
	struct iscsi_target_param_descr_t {
		// fields
	
		uint32_t :ref:`offer<doxid-structiscsi__target__param__descr__t_1a541e3ecb049c3d2c139c61f85056097f>`;
		char* :ref:`name<doxid-structiscsi__target__param__descr__t_1ad89c33dcfe2d0ed47b0a790f82843d86>`;
		bool :ref:`is_string<doxid-structiscsi__target__param__descr__t_1a5329d694be229320612ef3622c97cf92>`;
		enum :ref:`iscsi_target_param_kind_t<doxid-iscsi__initiator_8h_1ae5cb19938abdf3efa411afe3604d33e1>` :ref:`kind<doxid-structiscsi__target__param__descr__t_1afbec30dae57d92eba482b2be24159f22>`;
		int :ref:`offset<doxid-structiscsi__target__param__descr__t_1aff5c959b715a0fba48b4dba4e8ecceb1>`;
		:ref:`iscsi_param_formatter_t<doxid-iscsi__initiator_8h_1ae85903568531e3c6a881bb235af8ed5c>` :ref:`formatter<doxid-structiscsi__target__param__descr__t_1aeedbe53cb0dc2818581d3bae4697a5e3>`;
		:ref:`iscsi_param_predicate_t<doxid-iscsi__initiator_8h_1a1b97a7f5a48d8060b9dd6966a5099360>` :ref:`predicate<doxid-structiscsi__target__param__descr__t_1ab7fb89109480e788b66db5f542ddf62e>`;
	};
.. _details-structiscsi__target__param__descr__t:

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

Generic parameter description for :ref:`iscsi_write_param() <doxid-iscsi__initiator_8h_1a5de715c02988035c8120106f7c3f4a38>`

Fields
------

.. index:: pair: variable; offer
.. _doxid-structiscsi__target__param__descr__t_1a541e3ecb049c3d2c139c61f85056097f:

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

	uint32_t offer

OFFER_XXX mask

.. index:: pair: variable; name
.. _doxid-structiscsi__target__param__descr__t_1ad89c33dcfe2d0ed47b0a790f82843d86:

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

	char* name

Parameter name

.. index:: pair: variable; is_string
.. _doxid-structiscsi__target__param__descr__t_1a5329d694be229320612ef3622c97cf92:

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

	bool is_string

``true`` if the corresponding field is ``char *``, ``false`` if it is ``int``

.. index:: pair: variable; kind
.. _doxid-structiscsi__target__param__descr__t_1afbec30dae57d92eba482b2be24159f22:

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

	enum :ref:`iscsi_target_param_kind_t<doxid-iscsi__initiator_8h_1ae5cb19938abdf3efa411afe3604d33e1>` kind

Parameter type. It is used to choose one of data structures to take a field from

.. index:: pair: variable; offset
.. _doxid-structiscsi__target__param__descr__t_1aff5c959b715a0fba48b4dba4e8ecceb1:

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

	int offset

Field offset

.. index:: pair: variable; formatter
.. _doxid-structiscsi__target__param__descr__t_1aeedbe53cb0dc2818581d3bae4697a5e3:

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

	:ref:`iscsi_param_formatter_t<doxid-iscsi__initiator_8h_1ae85903568531e3c6a881bb235af8ed5c>` formatter

Converter function from the raw field value to text representation (may be NULL)

.. index:: pair: variable; predicate
.. _doxid-structiscsi__target__param__descr__t_1ab7fb89109480e788b66db5f542ddf62e:

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

	:ref:`iscsi_param_predicate_t<doxid-iscsi__initiator_8h_1a1b97a7f5a48d8060b9dd6966a5099360>` predicate

Predicate function to determine if a given parameter really needs to be configured depending on other parameters. ``NULL`` == always ``true``