Function dds_get_domainid

Function Documentation

dds_return_t dds_get_domainid(dds_entity_t entity, dds_domainid_t *id)

Get the domain id to which this entity is attached.

When creating a participant entity, it is attached to a certain domain. All the children (like Publishers) and childrens’ children (like DataReaders), etc are also attached to that domain.

This function will return the original domain ID when called on any of the entities within that hierarchy. For entities not associated with a domain, the id is set to DDS_DOMAIN_DEFAULT.

Parameters

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

  • id – [out] Pointer to put the domain ID in.

Return values

  • DDS_RETCODE_OK – Domain ID was returned.

  • DDS_RETCODE_ERROR – An internal error has occurred.

  • DDS_RETCODE_BAD_PARAMETER – The id parameter is NULL.

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

  • DDS_RETCODE_ALREADY_DELETED – The entity has already been deleted.

Returns

A dds_return_t indicating success or failure.