Namespace: Consultingwerk.Util
Class 
StartupParameterHelper Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Util.StartupParameterHelper

Inherits: Progress.Lang.Object


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



Top Method Summary
Options Name Purpose
CHARACTER BuildStartupParameterEntries (character) Builds the CHR(1) delimited list of startup parameters searched by GetStartupParameter
CHARACTER FindStartupParameter (character, character) Returns the startup parameter and its value from a CHR(1) delimited list of startup parameters
Consultingwerk.Framework.Collections.CharacterList FindStartupParameters (character, character) Returns all occurrences of a startup parameter and their values from a CHR(1) delimited list of startup parameters
Consultingwerk.Framework.Collections.CharacterList FindStartupParameterValues (character, character) Returns the values of all occurrences of a startup parameter from a CHR(1) delimited list of startup parameters
CHARACTER GetStartupParameter (character) Parses the session startup parameters list for the passed in startup parameter and returns the parameter and it's value
Consultingwerk.Framework.Collections.CharacterList GetStartupParameters (character) Returns all occurrences of the passed in startup parameter and their values
CHARACTER GetStartupParameterValue (character) Parses the session startup parameters list for the passed in startup parameter and returns the parameters value
Consultingwerk.Framework.Collections.CharacterList GetStartupParameterValues (character) Returns the values of all occurrences of the passed in startup parameter
CHARACTER ParseStartupParameters (character) Transforms a comma-delimited list of startup parameters into an ABL array

Top Constructor Summary
Options Name Purpose
StartupParameterHelper () Protected default constructor.
StartupParameterHelper () Transforms startup parameter from a comma-delimited list into an ABL array

Top Property Summary
Options Name Purpose
INTEGER IOEverywhere
CHARACTER StartupParameterList


Method Detail
Top

CHARACTER BuildStartupParameterEntries (character)
Purpose: Builds the CHR(1) delimited list of startup parameters searched
by GetStartupParameter
Notes: SCL-6030: The list starts and ends with CHR(1), so every
parameter is found as CHR(1) + entry + CHR(1). Returns an
empty string when there is no startup parameter. The list cannot
exceed the CHARACTER limit, it consists of parts of
SESSION:STARTUP-PARAMETERS STARTUP-PARAMETERS with one CHR(1) per comma

Parameters:
pcStartupParameters CHARACTER
The comma-delimited list of startup parameters (SESSION:STARTUP-PARAMETERS)
Returns CHARACTER
The CHR(1) delimited list of startup parameters
Top

CHARACTER FindStartupParameter (character, character)
Purpose: Returns the startup parameter and its value from a CHR(1)
delimited list of startup parameters
Notes: SCL-6030: The parameter name is compared case-sensitive. When
the parameter is specified more than once, the last occurrence
is returned - that is the one OpenEdge applies

Parameters:
pcStartupParameterEntries CHARACTER
The CHR(1) delimited list of startup parameters (result of BuildStartupParameterEntries)
pcParameter CHARACTER
The startup parameter to return (- not required)
Returns CHARACTER
The startup parameter and its value or ? when the parameter is not specified
Top

Consultingwerk.Framework.Collections.CharacterList FindStartupParameters (character, character)
Purpose: Returns all occurrences of a startup parameter and their values
from a CHR(1) delimited list of startup parameters
Notes: SCL-6031: The parameter name is compared case-sensitive. The
returned CharacterList uses CHR(1) as the delimiter, so values
containing a comma are returned as a single element

Parameters:
pcStartupParameterEntries CHARACTER
The CHR(1) delimited list of startup parameters (result of BuildStartupParameterEntries)
pcParameter CHARACTER
The startup parameter to return (- not required)
Returns Consultingwerk.Framework.Collections.CharacterList
The CharacterList with the occurrences of the startup parameter, empty when the parameter is not specified
Top

Consultingwerk.Framework.Collections.CharacterList FindStartupParameterValues (character, character)
Purpose: Returns the values of all occurrences of a startup parameter
from a CHR(1) delimited list of startup parameters
Notes: SCL-6031: The parameter name is compared case-sensitive. A
parameter without a value contributes an empty string - a
CharacterList that only contains an empty string has a Count
of 0, so this method is only meaningful for parameters that
take a value

Parameters:
pcStartupParameterEntries CHARACTER
The CHR(1) delimited list of startup parameters (result of BuildStartupParameterEntries)
pcParameter CHARACTER
The startup parameter to return the values for (- not required)
Returns Consultingwerk.Framework.Collections.CharacterList
The CharacterList with the values of the startup parameter, empty when the parameter is not specified
Top

CHARACTER GetStartupParameter (character)
Purpose: Parses the session startup parameters list for the passed in
startup parameter and returns the parameter and it's value
Notes: The parameter name is compared case-sensitive. SCL-6030: When
the parameter is specified more than once, the occurrence that
applies (the last one) is returned. For parameters that apply
more than once (-pf, -db, ...) use GetStartupParameters

Parameters:
pcParameter CHARACTER
The startup parameter to return the value for (- not required)
Returns CHARACTER
The value of the startup parameter
Top

Consultingwerk.Framework.Collections.CharacterList GetStartupParameters (character)
Purpose: Returns all occurrences of the passed in startup parameter and
their values
Notes: SCL-6031: For parameters that apply more than once (-pf, -db,
...). The parameter name is compared case-sensitive, the
occurrences are returned in the order of
SESSION:STARTUP-PARAMETERS STARTUP-PARAMETERS

Parameters:
pcParameter CHARACTER
The startup parameter to return (- not required)
Returns Consultingwerk.Framework.Collections.CharacterList
The CharacterList with the occurrences of the startup parameter (e.g. "-pf a.pf", "-pf b.pf"), empty when the parameter is not specified
Top

CHARACTER GetStartupParameterValue (character)
Purpose: Parses the session startup parameters list for the passed in
startup parameter and returns the parameters value
Notes: SCL-6030: When the parameter is specified more than once, the
value of the occurrence that applies (the last one) is returned.
For parameters that apply more than once (-pf, -db, ...) use
GetStartupParameterValues

Parameters:
pcParameter CHARACTER
The startup parameter to return the value for (- not required)
Returns CHARACTER
The value of the startup parameter
Top

Consultingwerk.Framework.Collections.CharacterList GetStartupParameterValues (character)
Purpose: Returns the values of all occurrences of the passed in startup
parameter
Notes: SCL-6031: For parameters that apply more than once and take a
value (-pf, -db, ...). The parameter name is compared
case-sensitive, the values are returned in the order of
SESSION:STARTUP-PARAMETERS. STARTUP-PARAMETERS. A parameter without a value
contributes an empty string - a CharacterList that only
contains an empty string has a Count of 0, so do not use this
method for parameters without a value (-b, -E, ...)

Parameters:
pcParameter CHARACTER
The startup parameter to return the values for (- not required)
Returns Consultingwerk.Framework.Collections.CharacterList
The CharacterList with the values of the startup parameter (e.g. "a.pf", "b.pf"), empty when the parameter is not specified
Top

CHARACTER ParseStartupParameters (character)
Purpose: Transforms a comma-delimited list of startup parameters into
an ABL array
Notes: SCL-5954: Removes the "(end .pf)" entries. An entry that does
not start with a dash is the continuation of the value of the
previous parameter (a value that contains a comma, e.g.
-param a=1,b=2) and is appended to the previous element -
unless it is the first entry or follows a "(end .pf)" entry,
then it remains an element of its own. A comma inside a value
that is directly followed by a dash (e.g. -param a,-b) cannot
be told apart from the next startup parameter.
Returns an indeterminate array when the list does not contain
any startup parameter

Parameters:
pcStartupParameters CHARACTER
The comma-delimited list of startup parameters (SESSION:STARTUP-PARAMETERS)
Returns CHARACTER
The ABL array of the startup parameters


Constructor Detail
Top

StartupParameterHelper ()
Purpose: Protected default constructor.
Notes: There's no need to create instances of the helper classes

Top

STATIC StartupParameterHelper ()
Purpose: Transforms startup parameter from a comma-delimited list into an
ABL array
Notes: Removes the "(end .pf)" entries. SCL-5954: The parsing is done
by ParseStartupParameters. The StartupParameterList remains
indeterminate when the session was started without any
startup parameter. SCL-6030: Also builds the CHR(1) delimited
list searched by GetStartupParameter



Property Detail
Top

INTEGER IOEverywhere

Returns INTEGER
Top

CHARACTER StartupParameterList

Returns CHARACTER


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       10.10.2026 15:35:54