Deletes an instance container identified by its name and the modelId. Only empty containers may be deleted. Use edmiEmptyInstanceContainer to remove all the contained instances. This function may not be used unless the container was assigned a name when it was created. I no name was assigned, use edmiDeleteInstanceContainer.
Related functions: edmiCreateInstanceContainer, edmiDeleteInstanceContainer, edmiEmptyContainer, edmiEmptyContainerBN, edmiGetInstanceContainerId, edmiGetInstanceContainers, edmiSetContainerCheckedout, edmiSetContainerCheckedoutBN, edmiUnsetContainerCheckedout, edmiUnsetContainerCheckedoutBN, edmiInstanceToContainer, edmiInstanceToContainerBN, edmiInstancesToContainer, edmiInstancesToContainerBN.
Header:
#include "sdai.h"
Prototype:
EdmiError edmiDeleteInstanceContainerBN (SdaiModel modelId,
SdaiString containerName);
Arguments:
modelId |
modelId that uniquely identifies the edmModel in the EDMdatabase. |
containerName |
The optional name that was assigned to the instance container when it was created. |
Returns:
A completion code of datatype EdmiError is the returned function value. The completion code has the following values:
Completion code = 0 : Operation successfully performed.
Completion code != 0: Error in operation. Completion code is an EDMinterface error code. Use edmiGetErrorText to get the error text corresponding to the error code.
Example:
EdmiError rstat;
SdaiModel modelId;
. . .
if (rstat = edmiDeleteInstanceContainerBN(modelId, "myContainer")) {
printf("\nError %d in edmiDeleteInstanceContainerBN: %s", rstat,
edmiGetErrorText(rstat));
goto err;
}
. . .