Function dds_get_qos

Function Documentation

dds_return_t dds_get_qos(dds_entity_t entity, dds_qos_t *qos)

Get entity QoS policies.

This operation allows access to the existing set of QoS policies for the entity.

Parameters

  • entity – [in] Entity on which to get qos.

  • qos – [out] Pointer to the qos structure that returns the set policies.

Return values

  • DDS_RETCODE_OK – The existing set of QoS policy values applied to the entity has successfully been copied into the specified qos parameter.

  • DDS_RETCODE_ERROR – An internal error has occurred.

  • DDS_RETCODE_BAD_PARAMETER – The qos 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. The QoS object will have at least all QoS relevant for the entity present and the corresponding dds_qget_… will return true.