DG Kernel Documentation


Skip Navigation Links.
Skip Navigation LinksHome Page > Deprecated > Deprecated API Reference > Model > IModelSearch_KC Search Documentation


IModelSearch_KC Interface

CreateDefaultDescription
FindItem

The interface allows finding entities by their types or other parameters.  The interface can be queried from IModel* interfaces

See also IInterface List


HRESULT CreateDefaultDescription(IDictionary_KC** description)

Parameters

description - [out, retval] New dictionary for the FindItem method

Remarks:

The method creates a new dictionary with default parameters and structure expected by the FindItem method


HRESULT FindItem(IDictionary_KC* description, IItem** iObject)

Parameters

description - [in] A dictionary created by the  CreateDefaultDescription() method

iObject- [out, retval] The found item or null reference if no matching item found

Remarks:

The method searches the model for the first item matching description. description must be created by the CreateDefaultDescription() method above

The dictionary has the following structure:

Name Type Description Default Value
EObjectType_Par Integer Valie must coinside with one of EObjectType enumeration. EObjectType.eObjTypeNULL
IncludeChildren Boolean If false only the top level objects are searched true

The method returns error if EObjectType_Par parameter was not specified

The above means that in this update onlysearch by entity type is available. Contact DInsight to request more options.