xpfGetEntityInSchemaBN

FUNCTION xpfGetEntityInSchemaBN (qualifiedSchemaName        : STRING;
                                 entityNameOrViewEntityName : STRING)  
                                 entityIdOrViewEntityId     : GENERIC;
                

The xpfGetEntityInSchemaBN function returns a numeric entityIdOrViewEntityId  that uniquely identifies an entity definition instance in the EDMdatabase. The entityIdOrViewEntityId  is returned in the argument <entityIdOrViewEntityId>. An entity name is unique within one dictionary model (Express schema). Hence the combination of <qualifiedSchemaName> and <entityNameOrViewEntityName> identifies one particular entity definition in the EDMdatabase. The actual dictionary model must be open before this function can be successfully performed. If the specified <entityNameOrViewEntityName> is the name of a legal complex entity that does not exist as an entity definition instance in the related dictionary model, an entity definition instance of the actual complex entity, will be created in the related dictionary model. The returned entityIdOrViewEntityId can be used to identify the actual entity in subsequent EDMinterface operations. The returned entityIdOrViewEntityId will be a constant value throughout the lifetime of the actual entity definition instance in the EDMdatabase.

Arguments

Return Value

Options

Example

<Missing Example>

See also