Function dds_dispose_ih

Function Documentation

dds_return_t dds_dispose_ih(dds_entity_t writer, dds_instance_handle_t handle)

This operation disposes an instance, identified by the instance handle.

This operation requests the Data Distribution Service to modify the instance and mark it for deletion. Copies of the instance and its corresponding samples, which are stored in every connected reader and, dependent on the QoS policy settings (also in the Transient and Persistent stores) will be modified and marked for deletion by setting their dds_instance_state_t to DDS_IST_NOT_ALIVE_DISPOSED.

The given instance handle must correspond to the value that was returned by either the dds_register_instance operation, dds_register_instance_ts or dds_lookup_instance. If there is no correspondence, then the result of the operation is unspecified.

Parameters

  • writer – [in] The writer to dispose the data instance from.

  • handle – [in] The handle to identify an instance.

Return values

  • DDS_RETCODE_OK – The sample is written and the instance is marked for deletion.

  • DDS_RETCODE_ERROR – An internal error has occurred.

  • DDS_RETCODE_BAD_PARAMETER – At least one of the arguments is invalid

  • DDS_RETCODE_ILLEGAL_OPERATION – The operation is invoked on an inappropriate object

  • DDS_RETCODE_ALREADY_DELETED – The entity has already been deleted

  • DDS_RETCODE_PRECONDITION_NOT_MET – The instance handle has not been registered with this writer

Returns

A dds_return_t indicating success or failure.