Skip to main content

dds_delete

Function dds_delete 

Source
pub unsafe extern "C" fn dds_delete(
    entity: dds_entity_t,
) -> dds_return_t
Expand description

@brief Delete given entity. @ingroup entity @component generic_entity

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

@param[in] entity Entity to delete.

@returns A dds_return_t indicating success or failure.

@retval DDS_RETCODE_OK The entity and its children (recursive are deleted). @retval DDS_RETCODE_ERROR An internal error has occurred. @retval DDS_RETCODE_ILLEGAL_OPERATION The operation is invoked on an inappropriate object. @retval DDS_RETCODE_ALREADY_DELETED The entity has already been deleted.