Function dds_delete

Function Documentation

dds_return_t dds_delete(dds_entity_t entity)

Delete given entity.

This operation will delete the given entity. It will also automatically delete all its children, childrens’ children, etc entities.

Parameters

entity[in] Entity to delete.

Return values
  • DDS_RETCODE_OK – The entity and its children (recursive are deleted).

  • DDS_RETCODE_ERROR – An internal error has occurred.

  • DDS_RETCODE_ILLEGAL_OPERATION – The operation is invoked on an inappropriate object.

  • DDS_RETCODE_ALREADY_DELETED – The entity has already been deleted.

Returns

A dds_return_t indicating success or failure.