BACnetStack_DeleteFDTEntry

bool BACnetStack_DeleteFDTEntry(const uint16_t index);

Deletes one entry from this device’s foreign device table by index.

This function takes no Network Port: it acts only on the foreign device table of the BACnet/IP data link the stack uses when no Network Port is named, which belongs to the first BACnet/IP Network Port object added. The index is the same index space as BACnetStack_GetFDTEntry() for that Network Port; with more than one BACnet/IP Network Port, an entry read from another port cannot be deleted through this function. Deleting shifts every later entry down by one. A loop that reads index N then deletes it will therefore SKIP the entry that moved into N. Delete from the highest index downwards, or re-enumerate from 0 after each delete.

This function transmits nothing - the removed foreign device is not told, and keeps sending to this BBMD until its own re-registration attempt fails.

Note

Requires the STACK_OPTION_NM_BBMDC (with STACK_OPTION_DATA_LINK_LAYER_IPV4 and STACK_OPTION_OBJECT_TYPE_NETWORK_PORT) build option (it turns on STACK_OPTION_BVLL_BBMD, the macro this function checks).

BACnet reference: ANSI/ASHRAE 135-2024 Annex J: J.5.2.1 (Foreign Device Table).

Parameters

Parameter	Direction	Description
index	in	The zero-based table position to delete.

Returns

True if an entry existed at that index and was removed. False if the index is out of range, the IPv4 datalink or the BBMD does not exist, or BBMD support was not compiled.

Topic: BACnet/IP: BBMD and foreign devices. Declared in CASBACnetStackDLL.h.