removeGroup()

The function removes a group connection from the panel.

Synopsis

int removeGroup(shape groupPointer);

int removeGroup(string moduleName, string panelName, string groupName);

int removeGroup(shape panel, string groupName);

Parameter

Parameter Description
groupPointer Pointer to the group connection that should be removed.
moduleName Name of the module.
panelName Name of the panel.
groupName Name of the group that should be removed.
panel Pointer to the panel.

Return value

In case of an error -1 is returned or 0 in case of a success.

Error

-

Description

The function allows to remove a group connection from a panel. The group can either be a shape-group, a layout group or a panel reference. The objects contained inside of the group remain within the panel and are not removed for shape and layout groups.

In case a panel reference is used as target the function behaves as if calling removeSymbol() and the reference is removed.

Example

Following example removes the group connection "myRectGroup" from the current panel. Using the function shapeExists() it is written to the log if the group exists before and after being removed.

main(mapping event)
{
  DebugN(shapeExists("myRectGroup"));
  removeGroup(self, "myRectGroup");
  DebugN(shapeExists("myRectGroup"));
}

Assignment

Graphics

Availability

UI