Function dds_take_status

• Defined in File dds.h

Function Documentation

dds_return_t dds_take_status(dds_entity_t entity, uint32_t *status, uint32_t mask)

Read the status set for the entity.

This operation reads the status(es) set for the entity based on the enabled status and mask set. It clears the status set after reading.

Parameters

• entity – [in] Entity on which the status has to be read.

• status – [out] Returns the status set on the entity, based on the enabled status.

• mask – [in] Filter the status condition to be read, 0 means all statuses

Return values

• DDS_RETCODE_OK – Success.

• DDS_RETCODE_BAD_PARAMETER – The entity parameter is not a valid parameter, status is a null pointer or mask has bits set outside the status range.

• DDS_RETCODE_ILLEGAL_OPERATION – The operation is invoked on an inappropriate object or mask has status bits set that are undefined for the type of entity.

• DDS_RETCODE_ALREADY_DELETED – The entity has already been deleted.

Returns

A dds_return_t indicating success or failure.