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

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

File:HandleDictionary
Purpose:A general purpose Dictionary 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 (character, handle) Adds the specified key and value to the dictionary.
AddWhenNotContained (character, handle) Adds the specified key and value to the dictionary only when it is not yet contained - silently ignores keys that are already contained
LOGICAL ContainsValue (handle) Determines whether the Dictionary contains the specified value.
Consultingwerk.Framework.Collections.HandleDictionaryEnumerator GetEnumerator () Returns the Enumerator for the Dictionary
HANDLE GetValue (character) Returns the Value for the specified Key
SetValue (character, handle) Assigns the Value for the specified Key

Top Constructor Summary
Options Name Purpose
HandleDictionary () Constructor for the Dictionary class
HandleDictionary (character) Constructor for the Dictionary class
HandleDictionary (character, character) Constructor for the Dictionary class
HandleDictionary (character, character, character, character) Constructor for the Dictionary class


Method Detail
Top

Add (character, handle)
Purpose: Adds the specified key and value to the dictionary.
Notes: Throws an InvalidParameterValueException when the dictionary
already contains the key (ContainsKey (pcKey) = TRUE)

Parameters:
pcKey CHARACTER
The key for the key/value pair to add to the dictionary
pValue HANDLE
The value for the key/value pair to add to the dictionary
Top

AddWhenNotContained (character, handle)
Purpose: Adds the specified key and value to the dictionary only
when it is not yet contained - silently ignores keys that
are already contained
Notes: Throws an InvalidParameterValueException when the dictionary
already contains the key (ContainsKey (pcKey) = TRUE)

Parameters:
pcKey CHARACTER
The key for the key/value pair to add to the dictionary
pValue HANDLE
The value for the key/value pair to add to the dictionary
Top

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

Parameters:
pValue HANDLE
The value to locate in the Dictionary
Returns LOGICAL
Logical value indicating if the value is contained in the Dictionary
Top

Consultingwerk.Framework.Collections.HandleDictionaryEnumerator GetEnumerator ()
Purpose: Returns the Enumerator for the Dictionary
Notes:

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

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

Parameters:
pcKey CHARACTER
The value to locate in the Dictionary
Returns HANDLE
The value for the specified key
Top

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

Parameters:
pcKey CHARACTER
The value to locate in the Dictionary
pValue HANDLE
The value to assign for the Key in the Dictionary


Constructor Detail
Top

HandleDictionary ()
Purpose: Constructor for the Dictionary class
Notes:

Top

HandleDictionary (character)
Purpose: Constructor for the Dictionary class
Notes:

Parameters:
pcDelimiter CHARACTER
The Delimiter to use for Keys and Values
Top

HandleDictionary (character, character)
Purpose: Constructor for the Dictionary class
Notes: Defaults to the comma (",") as the delimiter for Keys and Values

Parameters:
pcKeys CHARACTER
The initial list of Keys
pcValues CHARACTER
The initial list of Values
Top

HandleDictionary (character, character, character, character)
Purpose: Constructor for the Dictionary class
Notes:

Parameters:
pcKeys CHARACTER
The initial list of Keys
pcKeyDelimiter CHARACTER
The delimiter for the Keys
pcValues CHARACTER
The initial list of Values
pcValueDelimiter CHARACTER
The delimiter for the Values


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       13.04.2026 10:21:24