Function dds_register_instance

Function Documentation

dds_return_t dds_register_instance(dds_entity_t writer, dds_instance_handle_t *handle, const void *data)

Registers an instance.

This operation registers an instance with a key value to the data writer and returns an instance handle that could be used for successive write & dispose operations. When the handle is not allocated, the function will return an error and the handle will be un-touched.

Parameters

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

  • handle – [out] The instance handle.

  • 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.