LayOut C API

- Main Page
- Related Pages
- Data Structures
- Files

- File List
- Globals

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Functions
entityiterator.h File Reference
`#include <LayOutAPI/common.h>`
`#include <LayOutAPI/model/defs.h>`

Go to the source code of this file.

## Functions
LO_RESULT | LOEntityIteratorRelease (LOEntityIteratorRef *entity_iterator)
| Releases an entity iterator object. *entity_iterator will be set to invalid by this function. More...
LO_RESULT | LOEntityIteratorNext (LOEntityIteratorRef entity_iterator, LOEntityRef *entity)
| Gets a reference to the current entity and increment the iterator. entity will be set to an invalid object upon reaching the end of the iterator. More...

## Function Documentation

LO_RESULT LOEntityIteratorNext | ( | LOEntityIteratorRef | entity_iterator,
|  | LOEntityRef * | entity
| ) |  |

Gets a reference to the current entity and increment the iterator. entity will be set to an invalid object upon reaching the end of the iterator.

Parameters

  [in] | entity_iterator | The entity iterator object.
  [out] | entity | The entity object.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if entity_iterator does not refer to a valid object
  - SU_ERROR_NULL_POINTER_OUTPUT if entity does not refer to a valid object

LO_RESULT LOEntityIteratorRelease | ( | LOEntityIteratorRef * | entity_iterator | ) |

Releases an entity iterator object. *entity_iterator will be set to invalid by this function.

Parameters

  [in] | entity_iterator | The entity iterator object.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_NULL_POINTER_INPUT if entity_iterator is NULL
  - SU_ERROR_INVALID_INPUT if *entity_iterator does not refer to a valid object