BACnetStack_RemoveGroupMember
bool BACnetStack_RemoveGroupMember( const uint32_t deviceInstance, const uint32_t groupObjectInstance, const uint16_t memberObjectType, const uint32_t memberObjectInstance);Removes one member from a Group object’s stack-held List_Of_Group_Members.
The companion to BACnetStack_AddGroupMember().
The not-found and ordering semantics match the RemoveListElement service on the same property, so the host API and the network agree about the same list. The match differs on purpose: RemoveListElement compares the complete element, this call matches by object identifier alone:
- The member is identified by its object identifier alone; ALL of its property references go with it - there is no per-property removal here, so this is only sufficient when you want the member gone entirely, not when you want to drop one of several properties BACnetStack_AddGroupMember() appended to it.
- Removing a member that is not in the list FAILS and returns false. This is deliberately not idempotent - RemoveListElement answers listElementNotFound for the same request.
- The surviving members keep their order. ASHRAE 135-2024 cl. 12.14.5 does not mandate an order, but a client that reads the list, removes an entry and re-reads it would otherwise see the remainder shift.
BACnet reference: ANSI/ASHRAE 135-2024 clause 12.14 (Group Object Type).
Parameters
Section titled “Parameters”| Parameter | Direction | Description |
|---|---|---|
deviceInstance |
in | The device instance that owns this Group object. |
groupObjectInstance |
in | The Group object to remove the member from. |
memberObjectType |
in | The member object type. See CASBACnetStack::BACnetObjectType. With memberObjectInstance, this is one BACnet Object Identifier carried as two parameters. |
memberObjectInstance |
in | The member object instance. |
Returns
Section titled “Returns”True when a member was removed; false if the device or the Group object does not exist, the member is not in the list, or Group support is not compiled.
Topic: Schedules, calendars, trend logs and other object configuration. Declared in CASBACnetStackDLL.h.