Function dds_get_status_mask

Function Documentation

dds_return_t dds_get_status_mask(dds_entity_t entity, uint32_t *mask)

Get enabled status on entity.

This operation returns the status enabled on the entity

Parameters

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

  • mask – [out] Mask of enabled statuses set on the entity.

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.