Collapse All Expand All

C#

Clarion Library 6.1.1
Agent..::..Commit Method
Agent Class See Also Send Feedback

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

Commits the specified internal (ICommitable, functional) item to the agent

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

# Syntax

C#
    public void Commit(
    	ICommitable agentInternal
    )

#### Parameters

agentInternal
  Type: Clarion.Framework.Core..::..ICommitable
  The internal (functional) item that is to be committed

# Remarks

This method does the following:

- Moves the internal (functional) item from the "initializing" container to its appropriate internals container
- Makes the internal (functional) item immutable (i.e., read-only)
- Registers any event handler delegates for the internal (functional) item

Note
ALL internal (ICommitable, functional) items MUST be committed before they can be used by an agent. Failing to commit an internal (functional) item will likely lead to an error, or at least result in unanticipated behavior.

# Exceptions

Exception | Condition
--- | ---
System..::..ArgumentException | If the specified agent internal is not associated with this agent

# See Also

Agent Class
Clarion.Framework Namespace