Function dds_set_status_mask

Function Documentation

dds_return_t dds_set_status_mask(dds_entity_t entity, uint32_t mask)

Set status enabled on entity.

This operation enables the status(es) based on the mask set

Parameters

  • entity – [in] Entity to enable the status.

  • mask – [in] Status value that indicates the status to be enabled.

Return values

  • DDS_RETCODE_OK – Success.

  • DDS_RETCODE_BAD_PARAMETER – The entity parameter is not a valid parameter.

  • 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.