SketchUp C API
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Related Functions
SUEntityListRef Struct Reference

References an entity list. More...

#include <SketchUpAPI/model/entity_list.h>

Related Functions

(Note that these are not member functions.)

enum SUResult SUEntityListCreate (SUEntityListRef *list)
 Creates an entity list object. More...
 
enum SUResult SUEntityListRelease (SUEntityListRef *list)
 Releases a list object. More...
 
enum SUResult SUEntityListBegin (SUEntityListRef list, SUEntityListIteratorRef *iterator)
 Sets the iterator reference to the beginning of the list. The given iterator object must have been constructed using SUEntityListIteratorCreate(). The iterator must be released using SUEntityListIteratorRelease() when it is no longer needed. More...
 
enum SUResult SUEntityListSize (SUEntityListRef list, size_t *count)
 Gets the number of entities in the list. More...
 

Detailed Description

References an entity list.

Since
SketchUp 2018, API 6.0

Friends And Related Function Documentation

enum SUResult SUEntityListBegin ( SUEntityListRef  list,
SUEntityListIteratorRef iterator 
)
related

Sets the iterator reference to the beginning of the list. The given iterator object must have been constructed using SUEntityListIteratorCreate(). The iterator must be released using SUEntityListIteratorRelease() when it is no longer needed.

Since
SketchUp 2018, API 6.0
Parameters
[in]listThe list.
[out]iteratorAn iterator Ref reference the beginning of the list.
Returns
enum SUResult SUEntityListCreate ( SUEntityListRef list)
related

Creates an entity list object.

Since
SketchUp 2018, API 6.0
Parameters
[in,out]listThe entity list object to be created.
Returns
enum SUResult SUEntityListRelease ( SUEntityListRef list)
related

Releases a list object.

Since
SketchUp 2018, API 6.0
Parameters
[in,out]listThe list object to be released.
Returns
enum SUResult SUEntityListSize ( SUEntityListRef  list,
size_t *  count 
)
related

Gets the number of entities in the list.

Since
SketchUp 2018, API 6.0
Parameters
[in]listThe list object.
[out]countThe list size.
Returns

The documentation for this struct was generated from the following files: