edmiGetExtentBN

SdaiInstance edmiGetExtentBN(SdaiModel  model,
                               SdaiString entityName); 

Returns the numeric instanceID that uniquely identifies the entity extent instance for the specified instance type in the specified model. There is one entity extent instance in a model for each possible instance type in that model. The actual model must be open before this function can be successfully performed.

The sdaiGetEntityExtent and sdaiGetEntityExtentBN functions return the aggregateID of the attribute named instances in the related entity extent instance. The edmiGetExtent and edmiGetExtentBN functions return the instanceID of the related entity extent instance.

 

Arguments


TypeNameComment
SdaiModel

model

A numeric modelID that uniquely identifies the model of interest in the EDMdatabase .  The modelID is returned from the functions: sdaiCreateModel , sdaiCreateModelBN , sdaiOpenModelBN , edmiGetModel , edmiGetModelBN , sdaiGetInstanceModel

SdaiString

entityName

Specifies the name of the entity of interest, i.e. the entity that defines the instance type to return the entity extent instance of. Entity names are case insensitive.

Return Value


TypeComment
SdaiInstance

A datatype of EdmiError with the following values:

  1.  0: Error in operation. Completion code is an EDMinterface error code. Use edmiGetErrorText to get the error text corresponding to the error code.
  2. <> 0: identifier for the entity extent instance

 

Options


 

Example


 

 <example>

 

See also

Filter by label

There are no items with the selected labels at this time.

Â