Collapse All Expand All

C#

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

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

Gets an action chunk with the specified label. If an action chunk cannot be found, this method returns null.

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

# Syntax

C#
    public static ActionChunk GetActionChunk(
    	IComparable label
    )

#### Parameters

label
  Type: System..::..IComparable
  The label of an action chunk to get

#### Return Value

An action chunk with the specified label or null if an action chunk cannot be found

# Remarks

Caution
This method CANNOT guarantee correct retrieval unless ALL action chunks are initialized using a unique label. Since a label is optional for an action chunk and since multiple action chunks can have the same label, calling this method will only returns the FIRST instance of an action chunk with the specified label (if one is found). Keep this in mind if you plan to use this method to retrieve action chunks from the world.

# Exceptions

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

# See Also

World Class
GetActionChunk Overload
Clarion Namespace