Namespace: Consultingwerk.Framework.Collections
Class 
HandleList Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Framework.Base.AblPrimitiveList
Consultingwerk.Framework.Collections.HandleList

Inherits: Consultingwerk.Framework.Base.AblPrimitiveList
Implements: Consultingwerk.Framework.Base.ISupportsListChanged, Consultingwerk.Framework.Base.ISupportsListHash

File:HandleList
Purpose:A general purpose List class with a Character as
the key and a Integer as the value
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sun Jan 22 16:02:41 CET 2012

Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
Add (handle) Adds the specified value to the List.
AddWhenNotContained (handle) Adds the specified value to the List only when it is not yet contained - silently ignores keys that are already contained
LOGICAL ContainsValue (handle) Determines whether the List contains the specified value.
Consultingwerk.Framework.Collections.HandleListEnumerator GetEnumerator () Returns the Enumerator for the List
HANDLE GetValue (integer) Returns the Value for the specified Key
INTEGER IndexOf (handle) Returns the index of the given value in the list
Insert (handle, integer) Inserts the specified value to the List at the specified position
SetValue (integer, handle) Assigns the Value for the specified Key
HANDLE ToArray () Returns an array with the elements of the list
CHARACTER ToDelimitedList () Returns the list as an delimited character list
CHARACTER ToDelimitedList (character) Returns the list as an delimited character list

Top Constructor Summary
Options Name Purpose
HandleList () Constructor for the List class
HandleList (longchar) Constructor for the List class
HandleList (longchar, character) Constructor for the List class


Method Detail
Top

Add (handle)
Purpose: Adds the specified value to the List.
Notes:

Parameters:
pValue HANDLE
The value for the key/value pair to add to the List
Top

AddWhenNotContained (handle)
Purpose: Adds the specified value to the List only when it is not
yet contained - silently ignores keys that are already
contained
Notes:

Parameters:
pValue HANDLE
The value for the key/value pair to add to the List
Top

LOGICAL ContainsValue (handle)
Purpose: Determines whether the List contains the specified value.
Notes:

Parameters:
pValue HANDLE
The value to locate in the List
Returns LOGICAL
Logical value indicating if the List contains the value
Top

Consultingwerk.Framework.Collections.HandleListEnumerator GetEnumerator ()
Purpose: Returns the Enumerator for the List
Notes:

Returns Consultingwerk.Framework.Collections.HandleListEnumerator
The Enumerator instance
Top

HANDLE GetValue (integer)
Purpose: Returns the Value for the specified Key
Notes:

Parameters:
piIndex INTEGER
The index to remove from the List
Returns HANDLE
The Value for the specified Index
Top

INTEGER IndexOf (handle)
Purpose: Returns the index of the given value in the list
Notes: Returns 0 if the value is not in the list

Parameters:
pValue HANDLE
The value to locate in the list
Returns INTEGER
The index of the given value in the list
Top

Insert (handle, integer)
Purpose: Inserts the specified value to the List at the specified position
Notes:

Parameters:
pValue HANDLE
The value for the key/value pair to add to the List
piPosition INTEGER
The position to add the new value to
Top

SetValue (integer, handle)
Purpose: Assigns the Value for the specified Key
Notes:

Parameters:
piIndex INTEGER
The index to remove from the List
pValue HANDLE
The value to assign for the Key in the List
Top

HANDLE ToArray ()
Purpose: Returns an array with the elements of the list
Notes:

Returns HANDLE
The array with the elements of the list
Top

CHARACTER ToDelimitedList ()
Purpose: Returns the list as an delimited character list
Notes:

Returns CHARACTER
The character value with the delimited list
Top

CHARACTER ToDelimitedList (character)
Purpose: Returns the list as an delimited character list
Notes:

Parameters:
pcDelimiter CHARACTER
The delimiter for the list
Returns CHARACTER
The character value with the delimited list


Constructor Detail
Top

HandleList ()
Purpose: Constructor for the List class
Notes:

Top

HandleList (longchar)
Purpose: Constructor for the List class
Notes: Defaults to the comma (",") as the delimiter for Keys and Values

Parameters:
pcValues LONGCHAR
The initial list of Values
Top

HandleList (longchar, character)
Purpose: Constructor for the List class
Notes:

Parameters:
pcValues LONGCHAR
The initial list of Values
pcValueDelimiter CHARACTER
The delimiter for the Values


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       30.03.2026 11:04:13