:orphan:

.. index:: pair: struct; te_string
.. _doxid-structte__string:

struct te_string
================

.. toctree::
	:hidden:

Overview
~~~~~~~~

TE string type. :ref:`More...<details-structte__string>`


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

	#include <te_string.h>
	
	struct te_string {
		// fields
	
		char* :ref:`ptr<doxid-structte__string_1a05dac7a569f90c9a58e91b2bf600d63a>`;
		size_t :ref:`size<doxid-structte__string_1a904a31c9c728386f40a95a68924bbc0e>`;
		size_t :ref:`len<doxid-structte__string_1acd11a66f0f1b217baa7cb189c423abe8>`;
		bool :ref:`ext_buf<doxid-structte__string_1a61d803e7c90cff055880f1944a010980>`;
		te_string_free_func* :ref:`free_func<doxid-structte__string_1a22f337d98111ca081718a9e0c216e0d9>`;
	};
.. _details-structte__string:

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

TE string type.

Fields
------

.. index:: pair: variable; ptr
.. _doxid-structte__string_1a05dac7a569f90c9a58e91b2bf600d63a:

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

	char* ptr

Pointer to the buffer

.. index:: pair: variable; size
.. _doxid-structte__string_1a904a31c9c728386f40a95a68924bbc0e:

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

	size_t size

Size of the buffer

.. index:: pair: variable; len
.. _doxid-structte__string_1acd11a66f0f1b217baa7cb189c423abe8:

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

	size_t len

Length of the string

.. index:: pair: variable; ext_buf
.. _doxid-structte__string_1a61d803e7c90cff055880f1944a010980:

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

	bool ext_buf

If ``true``, buffer is supplied by user and should not be reallocated or freed.

.. index:: pair: variable; free_func
.. _doxid-structte__string_1a22f337d98111ca081718a9e0c216e0d9:

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

	te_string_free_func* free_func

If set, will be called from :ref:`te_string_free() <doxid-group__te__tools__te__string_1ga578106969a43ff2f9683418c918c2e15>` instead of default actions