Function dds_instance_get_key

• Defined in File dds.h

Function Documentation

dds_return_t dds_instance_get_key(dds_entity_t entity, dds_instance_handle_t inst, void *data)

This operation takes an instance handle and return a key-value corresponding to it.

Parameters

• entity – [in] Reader, writer, readcondition or querycondition entity.

• inst – [in] Instance handle.

• data – [out] pointer to an instance, to which the key ID corresponding to the instance handle will be returned, the sample in the instance should be ignored.

Return values

• DDS_RETCODE_OK – The operation was successful.

• DDS_RETCODE_BAD_PARAMETER – One of the parameters was invalid or the topic does not exist.

• DDS_RETCODE_ERROR – An internal error has occurred.

Returns

A dds_return_t indicating success or failure.