Collapse All Expand All

C#

Clarion Library 6.1.1
World..::..GetAgents Method (IComparable)
World Class See Also Send Feedback

[This is preliminary documentation and is subject to change.]

Gets a thread-safe "read-only" list of all of the agents in the world with the specified name.

Namespace: Clarion
Assembly: ClarionLibrary (in ClarionLibrary.dll) Version: 6.1.1.0 (6.1.1.0)

# Syntax

C#
    public static IEnumerable<Agent> GetAgents(
    	IComparable name
    )

#### Parameters

name
  Type: System..::..IComparable
  The name of the agents to get

#### Return Value

A "read-only" list of all the agents in the world with the specified name

# Remarks

Note
Manipulating the list returned by this method has no effect on the world itself. If you want to add or remove an item from the world you need to call either one of the "New..." methods or the "Remove" method (respectively).

# Exceptions

Exception | Condition
--- | ---
System..::..InvalidOperationException | If the singleton world instance has not been initialized

# See Also

World Class
GetAgents Overload
Clarion Namespace