entitylist.h File Reference

#include <LayOutAPI/common.h>
#include <LayOutAPI/model/defs.h>

Go to the source code of this file.

Functions
LO_RESULT	LOEntityListCreate (LOEntityListRef *entity_list)
	Creates a new entity list object. More...
LO_RESULT	LOEntityListRelease (LOEntityListRef *entity_list)
	Releases an entity list object. *entity_list will be set to invalid by this function. More...
LO_RESULT	LOEntityListAddEntity (LOEntityListRef entity_list, LOEntityRef entity)
	Adds an entity to an entity list object. More...
LO_RESULT	LOEntityListGetNumberOfEntities (LOEntityListRef entity_list, size_t *num_entities)
	Gets the number of entities in an entity list object. More...
LO_RESULT	LOEntityListGetEntityAtIndex (LOEntityListRef entity_list, size_t index, LOEntityRef *entity)
	Gets the entity at the specified index in an entity list object. More...

Function Documentation

LO_RESULT LOEntityListAddEntity	(	LOEntityListRef	entity_list,
		LOEntityRef	entity
	)

Adds an entity to an entity list object.

Parameters

[in]	entity_list	The entity list object.
[in]	entity	The entity object.

Returns

• SU_ERROR_NONE on success
• SU_ERROR_INVALID_INPUT if entity_list does not refer to a valid object
• SU_ERROR_INVALID_INPUT if entity does not refer to a valid object

LO_RESULT LOEntityListCreate

(

LOEntityListRef *

entity_list

)

Creates a new entity list object.

Parameters

[out]

entity_list

The entity list object.

Returns

• SU_ERROR_NONE on success
• SU_ERROR_NULL_POINTER_OUTPUT if entity_list is NULL
• SU_ERROR_OVERWRITE_VALID if *entity_list already refers to a valid object

LO_RESULT LOEntityListGetEntityAtIndex	(	LOEntityListRef	entity_list,
		size_t	index,
		LOEntityRef *	entity
	)

Gets the entity at the specified index in an entity list object.

Parameters

[in]	entity_list	The entity list object.
[in]	index	The index of the entity to get.
[out]	entity	The entity object.

Returns

• SU_ERROR_NONE on success
• SU_ERROR_INVALID_INPUT if entity_list does not refer to a valid object
• SU_ERROR_OUT_OF_RANGE if index is out of range for this list
• SU_ERROR_NULL_POINTER_OUTPUT if entity is NULL
• SU_ERROR_OVERWRITE_VALID if *entity already refers to a valid object

LO_RESULT LOEntityListGetNumberOfEntities	(	LOEntityListRef	entity_list,
		size_t *	num_entities
	)

Gets the number of entities in an entity list object.

Parameters

[in]	entity_list	The entity list object.
[out]	num_entities	The number of entities in this list.

Returns

• SU_ERROR_NONE on success
• SU_ERROR_INVALID_INPUT if entity_list does not refer to a valid object
• SU_ERROR_NULL_POINTER_OUTPUT if num_entities is NULL

LO_RESULT LOEntityListRelease

(

LOEntityListRef *

entity_list

)

Releases an entity list object. *entity_list will be set to invalid by this function.

Returns

• SU_ERROR_NONE on success
• SU_ERROR_NULL_POINTER_INPUT if entity_list is NULL
• SU_ERROR_INVALID_INPUT if *entity_list does not refer to a valid object