Function dds_get_sample_rejected_status¶
Defined in File dds_public_status.h
Function Documentation¶
-
dds_return_t dds_get_sample_rejected_status(dds_entity_t reader, dds_sample_rejected_status_t *status)¶
Get SAMPLE_REJECTED status.
This operation gets the status value corresponding to SAMPLE_REJECTED and reset the status. The value can be obtained, only if the status is enabled for an entity. NULL value for status is allowed and it will reset the trigger value when status is enabled.
- Parameters
reader – [in] The entity to get the status
status – [out] The pointer to DCPS_Status_SampleRejected to get the status
- Return values
DDS_RETCODE_ERROR – An internal error has occurred.
DDS_RETCODE_BAD_PARAMETER – One of the given arguments is not valid.
DDS_RETCODE_ILLEGAL_OPERATION – The operation is invoked on an inappropriate object.
DDS_RETCODE_ALREADY_DELETED – The entity has already been deleted.
- Returns
0 - Success
- Returns
<0 - Failure