Attempt to remove the given agent from this agent group.This function returns a result that will either succeed or return an error.
Verse using statement |
using { /Verse.org/AgentGroup } |
RemoveMember<public>(Agent:agent)<transacts>:result(success_type,error_type)
Parameters
RemoveMember takes the following parameters:
| Name | Type | Description |
|---|---|---|
Agent |
agent |
Attributes, Specifiers, and Effects
Specifiers
The following specifiers determine how you can interact with RemoveMember in your programs. For the complete list of specifiers, see the Specifiers Page.
| Specifier | Meaning |
|---|---|
public |
The identifier is universally accessible. You can use this on modules, classes, interfaces, structs, enums, methods, and data. |
Effects
The following effects determine how RemoveMember behaves in your programs. For the complete list of effects, see the Effect Specifers section of the Specifiers Page.
| Effect | Meaning |
|---|---|
transacts |
This effect indicates that any actions performed by the function can be rolled back. The transacts effect is required any time a mutable variable (var) is written. You’ll be notified when you compile your code if the transacts effect was added to a function that can’t be rolled back. Note that this check is not done for functions with the native specifier. |