xpfGetExtentBN

FUNCTION xpfGetExtentBN (modelId        : GENERIC;
                         entityName     : STRING)
                          entityExtentId : GENERIC;
 

The xpfGetExtentBN function returns the generic entityExtentId 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 xpxGetEntityExtent and xpxGetEntityExtentBN functions return the aggregateID of the attribute named instances in the related entity extent instance. The xpfGetExtent and xpfGetExtentBN functions return the instanceID of the related entity extent instance.

 

Arguments


TypeNameComment
GENERICmodelIdcomments
STRINGentityName 

Return Value


 

TypeNameComment
GENERICentityExtentIdcomments

Options


 

Example


  FUNCTION getEntityExtent(modelId : GENERIC ; entityName : STRING) : GENERIC;
    LOCAL
      extentId : GENERIC;
      members  : INTEGER;
    END_LOCAL;
      ON_ERROR_DO;
      xpxPrintf('\nError.');
      xpxThrow;
    END_ON_ERROR_DO;
    
    extentId := xpfGetEntityExtentBN(modelId,entityName); 
    members := xpfGetMemberCount(extentId);
    xpxPrintf('\n%d Members of type %s in model.',members,entityName);
    
    RETURN(extentId);
  END_FUNCTION;

 

See also

Filter by label

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