Logo  

struct.link.group

Syntax

s := struct.link.group(p<,slot>)
struct.link.group(p<,slot>) := s

Get/set the group name assigned to link p in slot slot, if provided. The slot named 'Default' is used by default if slot is not provided.

On set, a group index may be used instead of a string for s. On get or set, a slot index may be used instead of a string for slot. Indices operate more efficiently than strings.*

Returns:

s - the group name; None is returned if no group has been assigned in the given slot

Accepts:

s - the group name or index*; if not present, the group is created in the given slot

Arguments:

p - link pointer

slot - the slot name or index*; if not given, the slot name 'Default' is used

Note

*Use the group.find and group.find.slot intrinsics to obtain group and slot indices, respectively, and for further information.

Use of the group logic is described in Groups.

⇄
  • Itasca Software 9.1 documentation »
  • Itasca Software Guide »
  • Structural Elements »
  • Structural Element Links »
  • FISH Functions »


⇐ struct.link.find | struct.link.group.remove ⇒
Was this helpful? ... Itasca Software © 2024, Itasca Updated: Aug 13, 2024

9.1.13