Function dds_get_participant

• Defined in File dds.h

Function Documentation

dds_entity_t dds_get_participant(dds_entity_t entity)

Get entity participant.

This operation returns the participant to which the given entity belongs. For instance, it will return the Participant that was used when creating a Publisher that was used to create a DataWriter (when that DataWriter was provided here).

TODO: Link to generic dds entity relations documentation.

Parameters

entity – [in] Entity from which to get its participant.

Return values

• >0 – A valid participant handle.

• DDS_RETCODE_ERROR – An internal error has occurred.

• DDS_RETCODE_ILLEGAL_OPERATION – The operation is invoked on an inappropriate object.

• DDS_RETCODE_ALREADY_DELETED – The entity has already been deleted.

Returns

A valid entity or an error code.