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.
Note: 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.
Related functions: edmiGetExtent , sdaiGetEntityExtent , sdaiGetEntityExtentBN .
Header:
#include "sdai.h"
Prototype:
SdaiInstance edmiGetExtentBN(SdaiModel model,
SdaiString entityName);
Arguments:
model |
A numeric modelID that uniquely identifies the model of interest in the EDMdatabase. |
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. |
Returns:
A numeric instanceID that uniquely identifies the entity extent instance for the specified instance type in a specified model in the EDMdatabase will be returned. The instanceID can have the following values:
instanceID = 0 : Error in operation. Use sdaiErrorQuery to get error code and edmiGetErrorText to get the error message.
instanceID != 0: Function successfully performed.
EXAMPLE
SdaiInstance extentId;
SdaiModel modelId;
. . .
extentId = edmiGetExtentBN (modelId, "Organization",&extentId);
if (! extentId) {
/* Error in operation */
printf("\nError: %s in edmiGetExtentBN\n",
edmiGetErrorText(sdaiErrorQuery()));
goto error;
}
printf("\nextentId: %lu", extentId);
. . .