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

Inherits: Progress.Lang.Object


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



Top Method Summary
Options Name Purpose
LOGICAL AllowsCompile () Returns if the current session allows compilation of ABL source code
CHARACTER CurrentDirectory () Returns the current working directory
CHARACTER CurrentMethodName () Returns the name of the current method of the caller
CHARACTER ExecutablePath () Returns the name of the current Progress Executable
CHARACTER FullVersionString () Returns the Progress Version (incl. Service Pack Level)
CHARACTER GetAblAppName () Returns the current ABL application name
Consultingwerk.DateFormat GetDateFormat () Returns the current session date format
Consultingwerk.InternationalizationSettings GetInternationalizationSettings () Returns the current InternationalizationSettings
Consultingwerk.NumericFormat GetNumericFormat () Returns the current session numeric format
CHARACTER GetPatchLevel () Reads the Version file to see if there is a patch level
CHARACTER GetSessionParameter (character) Returns the value of a specific session parameter
CHARACTER GetSessionParameter (character, logical) Returns the value of a specific session parameter from -param
CHARACTER GetUserId () Returns the id of the current user Notes : On Windows the id of the current windows user is returned. On Linux the user id is resolved from the USER environment variable, falling back to LOGNAME when USER is not set @return The id of the current user */
CHARACTER GetUserName () Returns the display name of the current user Notes : On Windows the display name of the current windows user is returned. On Linux there is no direct equivalent for the display name, so the SessionManager:UserName is returned when set, otherwise the user id (see GetUserId) is returned instead @return The display name of the current user */
LOGICAL InputIsRedirected () Indicates whether the session is receiving redirected input (eg from < )
INTEGER ProcessBitness () Returns the "bitness" of the current process (32 / 64 bit)
DECIMAL ProVersionNumeric () Returns a numeric representation of the progress runtime version
SetDateFormat (DateFormat) Sets the Sessions date format
SetDefaultDateFormat () Sets the ABL default date format (mdy-1950)
SetDefaultInternationalizationSettings () Resets the InternationalizationSettings to the American Defaults
SetDefaultNumericFormat () Sets the ABL default numeric format (AMERICAN)
SetInternationalizationSettings (InternationalizationSettings) Sets the InternationalizationSettings
SetNumericFormat (NumericFormat) Sets the Sessions numeric format
CHARACTER StartupParameters () Returns the startup parameters of the current Progress session
CHARACTER UserHomeDirectory () Returns the home directory of the current user

Top Constructor Summary
Options Name Purpose
SessionHelper () Protected default constructor.

Top Property Summary
Options Name Purpose
CHARACTER AssembliesDirectory
CHARACTER AssembliesFullPath
CHARACTER DLC
CHARACTER PROMSGS


Method Detail
Top

LOGICAL AllowsCompile ()
Purpose: Returns if the current session allows compilation of ABL source code
Notes: Compiles a non existing .p file (random file name) and tests the
error message.

Returns LOGICAL
Logical value indicating if the current session allows compilation
Top

CHARACTER CurrentDirectory ()
Purpose: Returns the current working directory
Notes:

Returns CHARACTER
The current working directory
Top

CHARACTER CurrentMethodName ()
Purpose: Returns the name of the current method of the caller
Notes: Returns the first entry by space of PROGRAM-NAME(2)

Returns CHARACTER
The name of the current method of the caller
Top

CHARACTER ExecutablePath ()
Purpose: Returns the name of the current Progress Executable
Notes: Uses System.Environment:CommandLine

Returns CHARACTER
The path to the current executable
Top

CHARACTER FullVersionString ()
Purpose: Returns the Progress Version (incl. Service Pack Level)
Notes: From src/adecomm/_about.p

Returns CHARACTER
The full progress version string
Top

CHARACTER GetAblAppName ()
Purpose: Returns the current ABL application name
Notes: Only applicable to AppServer sessions

Returns CHARACTER
The ABL application name
Top

Consultingwerk.DateFormat GetDateFormat ()
Purpose: Returns the current session date format
Notes:

Returns Consultingwerk.DateFormat
The Consultingwerk.DateFormat with the current session Settings
Top

Consultingwerk.InternationalizationSettings GetInternationalizationSettings ()
Purpose: Returns the current InternationalizationSettings
Notes:

Returns Consultingwerk.InternationalizationSettings
The InternationalizationSettings instance describing the Date- and NumericFormat
Top

Consultingwerk.NumericFormat GetNumericFormat ()
Purpose: Returns the current session numeric format
Notes:

Returns Consultingwerk.NumericFormat
The Consultingwerk.NumericFormat with the current session Settings
Top

CHARACTER GetPatchLevel ()
Purpose: Reads the Version file to see if there is a patch level
Notes: From src/adecomm/_about.p

Returns CHARACTER
The current patch level
Top

CHARACTER GetSessionParameter (character)
Purpose: Returns the value of a specific session parameter
Notes: Searches for the parameter in the session startup parameters

Parameters:
pcParameter CHARACTER
The parameter name to search for (without leading dash)
Returns CHARACTER
The value of the specified parameter or ? if not found
Top

CHARACTER GetSessionParameter (character, logical)
Purpose: Returns the value of a specific session parameter from -param
Notes: Searches for the parameter in the session startup parameters

Parameters:
pcParameter CHARACTER
The parameter name to search for (without leading dash)
plThrowIfMissing LOGICAL
Optional flag to throw an exception if the parameter is not found
Returns CHARACTER
The value of the specified parameter or the unknown value if not found
Top

CHARACTER GetUserId ()
Purpose: Returns the id of the current user
Notes : On Windows the id of the current windows user is returned. On Linux
the user id is resolved from the USER environment variable, falling
back to LOGNAME when USER is not set

Returns CHARACTER
The id of the current user
Top

CHARACTER GetUserName ()
Purpose: Returns the display name of the current user
Notes : On Windows the display name of the current windows user is returned.
On Linux there is no direct equivalent for the display name, so the
SessionManager:UserName UserName is returned when set, otherwise the user id
(see GetUserId) is returned instead

Returns CHARACTER
The display name of the current user
Top

LOGICAL InputIsRedirected ()
Purpose: Indicates whether the session is receiving redirected input (eg from < )
Notes: If the current SESSION:CLIENT-TYPE is not webclient or a 4GL runtime, then
the result is always FALSE.

Returns LOGICAL
If TRUE, then STDIN is redirected to a WebClient or 4GLClient AVM process; FALSE otherwise.
Top

INTEGER ProcessBitness ()
Purpose: Returns the "bitness" of the current process (32 / 64 bit)
Notes:

Returns INTEGER
32 or 64 depending on the current Process process
Top

DECIMAL ProVersionNumeric ()
Purpose: Returns a numeric representation of the progress runtime version
Notes: The return value is built using the major version before the comma
and the minor version behind the comma

Returns DECIMAL
The numeric representation of the progress runtime version, e.g. 10,2 or 11,1
Top

SetDateFormat (DateFormat)
Purpose: Sets the Sessions date format
Notes:

Parameters:
poDateFormat Consultingwerk.DateFormat
The DateFormat object with the settings for the current session
Top

SetDefaultDateFormat ()
Purpose: Sets the ABL default date format (mdy-1950)
Notes:

Top

SetDefaultInternationalizationSettings ()
Purpose: Resets the InternationalizationSettings to the American Defaults
Notes:

Top

SetDefaultNumericFormat ()
Purpose: Sets the ABL default numeric format (AMERICAN)
Notes:

Top

SetInternationalizationSettings (InternationalizationSettings)
Purpose: Sets the InternationalizationSettings
Notes:

Parameters:
poSettings Consultingwerk.InternationalizationSettings
The InternationalizationSettings instance describing the Date- and NumericFormat
Top

SetNumericFormat (NumericFormat)
Purpose: Sets the Sessions numeric format
Notes:

Parameters:
poNumericFormat Consultingwerk.NumericFormat
The NumericFormat object with the settings for the current session
Top

CHARACTER StartupParameters ()
Purpose: Returns the startup parameters of the current Progress session
Notes: Uses System.Environment:CommandLine

Returns CHARACTER
The list of session startup parameters
Top

CHARACTER UserHomeDirectory ()
Purpose: Returns the home directory of the current user
Notes: OpenEdge does not resolve a leading ~ in file names - tilde
expansion is a feature of the Unix shell, which expands the
character before the program ever sees the file name. Code that
stores per user data therefore has to resolve the home directory
itself instead of building a path such as "~/MyFolder", which
would create a directory literally named "~" below the current
working directory.
On Unix/Linux the HOME environment variable is used, on Windows
USERPROFILE with HOMEDRIVE + HOMEPATH as the fallback.
Note that in a PAS for OpenEdge or AppServer session HOME is the
home directory of the account that started the broker, not of an
end user - this method is intended for client and tooling code.

Returns CHARACTER
The home directory of the current user, the unknown value when it cannot be determined


Constructor Detail
Top

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



Property Detail
Top

CHARACTER AssembliesDirectory

Returns CHARACTER
Top

CHARACTER AssembliesFullPath

Returns CHARACTER
Top

CHARACTER DLC

Returns CHARACTER
Top

CHARACTER PROMSGS

Returns CHARACTER


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       19.09.2026 10:19:55