IModelObjectCollection Interface Reference

Represents a model object collection. More...

Inheritance diagram for IModelObjectCollection:

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

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 GetById	(	[in] int	id,
		[out, retval] IModelObject **	ppModelObject )

Gets an object by its identifier.

Returns

The object.

GetByIndex()

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

Gets an object by the given index.

Returns

The object.

GetByUniqueId()

HRESULT GetByUniqueId	(	[in] GUID	id,
		[out, retval] IModelObject **	ppEntity )

Gets an object by its unique identifier.

Returns

The object.

GetIds()

HRESULT 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.