Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagecpp
themeConfluence
EdmiError edmiGetEntityInSchema(SdaiSchema  schemaId,
                                 SdaiString  entityName, 
                                 SdaiEntity  *entityId);

Returns a numeric entityID that uniquely identifies an entity definition instance in the EDMdatabase. An entity name is unique within one dictionary model (Express schema). Hence the combination of <schemaId> and <entityName> 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 <entityName> 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 entityID can be used to identify the actual entity in subsequent EDMinterface operations. The returned entityID will be a constant value throughout the lifetime of the actual entity definition instance in the EDMdatabase.

...

Arguments

...

TypeNameComment
SdaiSchema

schemaId

A numeric schemaID that uniquely identifies an Express schema in an EDMdatabase. The < schemaId> can be retrieved by the edmiGetSchema operation.

SdaiString

entityName

Specifies the name of the entity of interest. Entity names are case insensitive.

SdaiEntity

entityId

Address of the variable that will receive the numeric entityID that uniquely identifies the entity definition instance of interest in the EDMdatabase.

...

Return Value

...

Insert excerpt
US:_r_EDMInterface
US:_r_EDMInterface
nopaneltrue

Options

...

 

Example

...

 

Code Block
languagecpp
 EdmiError rstat;
 SdaiSchema schemaId;
 SdaiEntity entityId;
 . . .
 if (rstat = edmiGetEntityInSchema(schemaId, "Document", &entityId)) {
 /* Error in operation */ 
 printf("\nError: %s in edmiGetEntityInSchema\n",

...

 
 edmiGetErrorText(rstat));

...

 
 goto error;

...

 
 }
 printf("\nentityId: %lu", entityId);

...


 . . .

 

See also

Filter by label (Content by label)
showLabelsfalse
showSpacefalse
cqllabel = "model" and parent = "6062220"