flowplane.zone.group.remove
Syntax
- b := flowplane.zone.group.remove(fpzp,s<,slot>)
Remove the group s from the flowplane zone in any slot. The removal of s will only occur in slot, if provided.
A group index or slot index may be used for the arguments s or slot, respectively. Indices operate more efficiently than strings*.
- Returns:
b - true when the group is removed from one or more slots of the flowplane zone, false if the group is not found
- Arguments:
fpzp - flowplane zone pointer
s - the group name or index*
slot - the slot name or index* (restricts removal of s to that slot)
Note
*Use the
group.find
andgroup.find.slot
intrinsics to obtain group and slot indices, respectively, and for further information.Use of the group logic is described in Groups.
Was this helpful? ... | Itasca Software © 2024, Itasca | Updated: Sep 26, 2024 |