xpxGetEntity

FUNCTION xpxGetEntity (modelId      : GENERIC;
                       entityName   : STRING;
                       VAR entityId : GENERIC)
                       status       : INTEGER;

The xpxGetEntity function returns the instanceId of the entity_definition instance of the specified entity; The entity_definition instance is located in the dictionary model of the actual Express schema in EDM. An entity_definition is uniquely defined by the arguments modelId and entityName. The instanceId of the actual entity_definition instance is returned in the entityId argument.

Arguments

Return Value

Options

Example

FUNCTION getEntity(modelId : GENERIC; entityName : STRING) : GENERIC;
LOCAL
   entityId : GENERIC;
   name : STRING;
END_LOCAL;
ON_ERROR_DO;
   xpxPrintf('\nError.');
   xpxThrow;
END_ON_ERROR_DO;

xpxGetEntity(modelId,entityName,entityId);
xpxPrintf('\nentiyId : %lu',entityId);
name := entityId.name;
xpxPrintf('\nEntity name : %s',name);
IF(name <> entityName) THEN
   xpxThrow;
END_IF;

RETURN(entityId);
END_FUNCTION;

See also