8.2.2.7 Method RemoveTimeSynchronizationRecipients

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
RemoveFromUtcListIndicates if the recipient is removed from Time_Synchronization_Recipients or to UTC_Time_Synchronization_Recipients.
TimeSynchronizationRecipientsArray 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.
FirstFailedElementNumberThe 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
BadNodeIdUnknownThis status is returned for the BACnet error codes UNKNOWN_OBJECT and UNKNOWN_PROPERTY
BadTypeMismatchThis status is returned for the BACnet error codes INVALID_DATATYPE
BadOutOfRangeThis status is returned for the BACnet error code VALUE_OUT_OF_RANGE
BadNotWritableThis status is returned for the BACnet error code WRITE_ACCESS_DENIED
BadNotFoundThis status is returned for the BACnet error code LIST_ELEMENT_NOT_FOUND