Function dds_get_parent

Function Documentation

dds_entity_t dds_get_parent(dds_entity_t entity)

Get entity parent.

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

When a reader or a writer are created with a participant, then a subscriber or publisher are created implicitly. This function will return the implicit parent and not the used participant.

Parameters

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

Return values

  • >0 – A valid entity handle.

  • DDS_ENTITY_NIL – Called with a participant.

  • 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 handle or an error code.