:orphan:

.. index:: pair: struct; tapi_job_opt_array
.. _doxid-structtapi__job__opt__array:

struct tapi_job_opt_array
=========================

.. toctree::
	:hidden:

Overview
~~~~~~~~

The descriptor for an array-typed field. :ref:`More...<details-structtapi__job__opt__array>`


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

	#include <tapi_job_opt.h>
	
	struct tapi_job_opt_array {
		// fields
	
		size_t :ref:`array_offset<doxid-structtapi__job__opt__array_1a55d25f6c9d0201adad0dea6a5d67039f>`;
		bool :ref:`is_ptr<doxid-structtapi__job__opt__array_1ad4f98754bc147f8e3708d1a0c0e4d31f>`;
		size_t :ref:`element_size<doxid-structtapi__job__opt__array_1a2afaddcedc87cf112b9c4f4261cce210>`;
		const char* :ref:`sep<doxid-structtapi__job__opt__array_1a59ff1bb6eadd7551970f92eb2ffdabb7>`;
		:ref:`tapi_job_opt_bind<doxid-structtapi__job__opt__bind>` :ref:`bind<doxid-structtapi__job__opt__array_1afe48034bd5d72e1bf4c4dac25262293a>`;
	};
.. _details-structtapi__job__opt__array:

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

The descriptor for an array-typed field. This structure shall *never* be used directly, see :ref:`TAPI_JOB_OPT_ARRAY() <doxid-group__tapi__job__opt__bind__constructors_1gab55685aede972d6dac2f3f2e68d96115>`

Fields
------

.. index:: pair: variable; array_offset
.. _doxid-structtapi__job__opt__array_1a55d25f6c9d0201adad0dea6a5d67039f:

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

	size_t array_offset

The offset of the data field relative to the length

.. index:: pair: variable; is_ptr
.. _doxid-structtapi__job__opt__array_1ad4f98754bc147f8e3708d1a0c0e4d31f:

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

	bool is_ptr

The data field contains a pointer to an array.

.. index:: pair: variable; element_size
.. _doxid-structtapi__job__opt__array_1a2afaddcedc87cf112b9c4f4261cce210:

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

	size_t element_size

Size of an element in the array

.. index:: pair: variable; sep
.. _doxid-structtapi__job__opt__array_1a59ff1bb6eadd7551970f92eb2ffdabb7:

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

	const char* sep

Separator between array elements

.. index:: pair: variable; bind
.. _doxid-structtapi__job__opt__array_1afe48034bd5d72e1bf4c4dac25262293a:

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

	:ref:`tapi_job_opt_bind<doxid-structtapi__job__opt__bind>` bind

Option bind for every element in the array