Function dds_lookup_participant

Function Documentation

dds_return_t dds_lookup_participant(dds_domainid_t domain_id, dds_entity_t *participants, size_t size)

Get participants of a domain.

This operation acquires the participants created on a domain and returns the number of found participants.

This function takes a domain id with the size of pre-allocated participant’s list in and will return the number of found participants. It is possible that the given size of the list is not the same as the number of found participants. If less participants are found, then the last few entries in an array stay untouched. If more participants are found and the array is too small, then the participants returned are undefined.

Parameters

  • domain_id – [in] The domain id.

  • participants – [out] The participant for domain.

  • size – [in] Size of the pre-allocated participant’s list.

Return values

  • >0 – Number of participants found.

  • DDS_RETCODE_ERROR – An internal error has occurred.

  • DDS_RETCODE_BAD_PARAMETER – The participant parameter is NULL, while a size is provided.

Returns

Number of participants found or and error code.