I_Immutable_List (Interface)

Interface for an immutable list.

Extends: I_Immutable_Collection

Properties

_Begin

Type: T_Position

Index of the first element.

_End

Type: T_Position

Index of the last element.

Methods

Contains

Returns: BOOL

Checks if item is contained in list

Inputs

Name	Type	Description
Item	ANY	Item to find in list

Get

Returns: I_Immutable_List

Gets item from list at specified location without removing it.

Inputs

Name	Type	Description
Index	T_Position	Location of item
Item	ANY	Variable to store returned item

Outputs

Name	Type	Description
bSuccess	BOOL

Get_As_String

Returns: I_Immutable_List

Returns item as a string, if type to string conversion is supported.

Inputs

Name	Type	Description
Index	T_Position	Location of item
sItem	REFERENCE TO STRING	Variable to store returned item.

Outputs

Name	Type	Description
bSuccess	BOOL

Get_Type_At

Returns: I_Immutable_List

Gets the type of the item at specified location.

Inputs

Name	Type	Description
Index	T_Position

Outputs

Name	Type	Description
Item_Type	T_Type
bSuccess	BOOL

Search

Returns: I_Immutable_List

Find the location of an item in list.

Inputs

Name	Type	Description
Item	ANY	Item to find in list

Outputs

Name	Type	Description
Index	T_Position	Location of item in list
bSuccess	BOOL