v2.17
IModelObjectCollection Interface Reference

Represents a model object collection. More...

Inheritance diagram for IModelObjectCollection:

Public Member Functions

HRESULT GetByIndex ([in] int index, [out, retval] IModelObject **ppModelObject)
 Gets an object by the given index. More...
 
HRESULT GetById ([in] int id, [out, retval] IModelObject **ppModelObject)
 Gets an object by its identifier. More...
 
HRESULT GetIds ([out, retval] SAFEARRAY(int) *pIds)
 Gets the identifiers of objects in the collection. More...
 

Properties

int Count [get]
 The number of objects in the collection.
 

Detailed Description

Represents a model object collection.

Using this interface you can obtain model objects. This interface can be obtained through IModel.

Member Function Documentation

◆ GetById()

HRESULT IModelObjectCollection::GetById ( [in] int  id,
[out, retval] IModelObject **  ppModelObject 
)

Gets an object by its identifier.

Returns
The object.

◆ GetByIndex()

HRESULT IModelObjectCollection::GetByIndex ( [in] int  index,
[out, retval] IModelObject **  ppModelObject 
)

Gets an object by the given index.

Returns
The object.

◆ GetIds()

HRESULT IModelObjectCollection::GetIds ( [out, retval] SAFEARRAY(int) *  pIds)

Gets the identifiers of objects in the collection.

Returns
An array containing the identifiers of objects in the collection.