Function dds_unregister_instance¶
Defined in File dds.h
Function Documentation¶
-
dds_return_t dds_unregister_instance(dds_entity_t writer, const void *data)¶
Unregisters an instance.
This operation reverses the action of register instance, removes all information regarding the instance and unregisters an instance with a key value from the data writer.
- Parameters
writer – [in] The writer to which instance is associated.
data – [in] The instance with the key value.
- 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.