This Method removes entries from the BACnet property Time_Synchronization_Recipients or UTC_Time_Synchronization_Recipients.
Signature
RemoveTimeSynchronizationRecipients (
[in]0:Boolean RemoveFromUtcList
[in]BACnetRecipient [] TimeSynchronizationRecipients
[out]0:UInt32 FirstFailedElementNumber
);
Argument |
Description |
RemoveFromUtcList |
Indicates if the recipient is removed from Time_Synchronization_Recipients or to UTC_Time_Synchronization_Recipients. |
TimeSynchronizationRecipients |
Array of time synchronization recipients. Based on the AddToUtcList parameter, the recipients are removed from the BACnet property Time_Synchronization_Recipients or UTC_Time_Synchronization_Recipients. The BACnetRecipient DataType is defined in 10.6.9. |
FirstFailedElementNumber |
The numerical position, starting at 1, of the failed element in the TimeSynchronizationRecipients. If the call succeeds or fails for other reasons, the returned value shall be 0. |
Method Result Codes
ResultCode |
Description |
BadNodeIdUnknown |
This status is returned for the BACnet error codes UNKNOWN_OBJECT and UNKNOWN_PROPERTY |
BadTypeMismatch |
This status is returned for the BACnet error codes INVALID_DATATYPE |
BadOutOfRange |
This status is returned for the BACnet error code VALUE_OUT_OF_RANGE |
BadNotWritable |
This status is returned for the BACnet error code WRITE_ACCESS_DENIED |
BadNotFound |
This status is returned for the BACnet error code LIST_ELEMENT_NOT_FOUND |