Deletes an instance container identified by a containerId. Only empty containers may be deleted. Use edmiEmptyInstanceContainer to remove all the contained instances.
Related functions: edmiCreateInstanceContainer, edmiDeleteInstanceContainerBN, edmiEmptyContainer, edmiEmptyContainerBN, edmiGetInstanceContainerId, edmiGetInstanceContainers, edmiSetContainerCheckedout, edmiSetContainerCheckedoutBN, edmiUnsetContainerCheckedout, edmiUnsetContainerCheckedoutBN, edmiInstanceToContainer, edmiInstanceToContainerBN, edmiInstancesToContainer, edmiInstancesToContainerBN.
Header:
#include "sdai.h"
Prototype:
EdmiError edmiDeleteInstanceContainer(SdaiContainer containerId);
Arguments:
containerId |
The containerId that uniquely identifies the instance container within the EDMdatabase . |
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;
SdaiContainer contId;
. . .
if (rstat = edmiDeleteInstanceContainer(contId)) {
printf("\nError %d in edmiDeleteInstanceContainer: %s", rstat,
edmiGetErrorText(rstat));
goto err;
}
. . .