Function dds_dispose_ih_ts

Function Documentation

dds_return_t dds_dispose_ih_ts(dds_entity_t writer, dds_instance_handle_t handle, dds_time_t timestamp)

This operation disposes an instance with a specific timestamp, identified by the instance handle.

This operation performs the same functions as dds_dispose_ih except that the application provides the value for the source_timestamp that is made available to connected reader objects. This timestamp is important for the interpretation of the destination_order QoS policy.

Parameters

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

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

  • timestamp – [in] The timestamp used as source timestamp.

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.