Function dds_unregister_instance_ih_ts

Function Documentation

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

Unregisters an instance.

This operation unregisters an instance with a key value from the handle. Instance can be identified from instance handle. If an unregistered key ID is passed as an instance data, an error is logged and not flagged as return value.

Parameters

  • writer – [in] The writer to which instance is associated.

  • handle – [in] The instance handle.

  • timestamp – [in] The timestamp used at registration.

Return values

  • DDS_RETCODE_OK – The operation was successful

  • DDS_RETCODE_BAD_PARAMETER – One of the given arguments is not valid

  • DDS_RETCODE_ILLEGAL_OPERATION – The operation is invoked on an inappropriate object

Returns

A dds_return_t indicating success or failure.