Powered by Zoomin Software. For more details please contactZoomin

OpenEdge ABL API Reference

OpenEdge.Core.ServerConnection.ConnectionParameters

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
Print
Table of Contents

OpenEdge.Core.ServerConnection.ConnectionParameters

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
Print
  • Last Updated: January 15, 2026
  • 3 minute read
    • OpenEdge
    • Version 12.8
    • Documentation
Namespace: OpenEdge.Core.ServerConnection
Type: Class ConnectionParameters
Parent Classes:
Progress.Lang.Object
OpenEdge.Core.ServerConnection.ConnectionParameters

Inherits: Progress.Lang.Object
Implements: OpenEdge.Core.ServerConnection.IConnectionParameters

Copyright (c) 2013, 2021, 2023 by Progress Software Corporation. All rights reserved.
File:ConnectionParameters
Purpose:Standard Connection Parameters
Author(s):pjudge
Created:Thu Feb 28 15:07:49 EST 2013
Notes:* The Options property contains JSON data.
This Json Data is structured as follows:
{"option1":"value1", "option2":"value2", ..., "optionN":"valueN"}
the ABL SUBSTITUTE function. It can include up to 9 substitutions (&1-&9)
and should also include any key/value pair separators (space, usually).
Purpose: A set of options for a Server Connection



Method Summary
  Options Name Purpose
  CHARACTER GetConnectionString () /** Returns the Options as a formatted string for use by the server to connect. This may be the the ABL CONNECT statement or some other parameter. @return character A useable string of connection parameters. */
  CHARACTER GetConnectionString (character) /** Returns the Options as a formatted string for use by the server to connect. This may be the the ABL CONNECT statement or some other parameter. @param character The format mask to use. Overrides the mask specified by the property. @return character A useable string of connection parameters. */
  CHARACTER GetConnectionString (FormatMaskEnum) /** Returns the Options as a formatted string for use by the server to connect. This may be the the ABL CONNECT statement or some other parameter. @param FormatMaskEnum The format mask to use. Overrides the mask specified by the property. @return character A useable string of connection parameters. */
  CHARACTER GetConnectionString (JsonObject, character) /** Returns the Options as a formatted string for use by the server to connect. This may be the the ABL CONNECT statement or some other parameter. @param JsonObject Options in JSON format. @param character The format mask to use. @return character A useable string of connection parameters. */
  Initialise () /** Use this method for setting initial or default values, or other similar actions */
  ShadowConstructor (JsonObject, FormatMaskEnum) /** Shadow constructor for this class. Used instead of a real constructor since some transformations have to happen before its called, and since a constructor must be invoked first via SUPER or THIS-OBJECT, there's no room for those transformations. @param JsonObject The options in JSON form @param FormatMaskEnum The Format mask to use for this connection. */

Constructor Summary
  Options Name Purpose
  ConnectionParameters (character, FormatMaskEnum)
  ConnectionParameters (JsonObject, FormatMaskEnum)

Property Summary
  Options Name Purpose
  OpenEdge.Core.ServerConnection.FormatMaskEnum FormatMask
  Progress.Json.ObjectModel.JsonObject Options
  CHARACTER ResolvedOptions


Method Detail
Top

CHARACTER GetConnectionString ()

Purpose: Returns the Options as a formatted string for use by the server to connect.
This may be the the ABL CONNECT statement or some other parameter.
Returns CHARACTER
  character A useable string of connection parameters.
Top

CHARACTER GetConnectionString (character)

Purpose: Returns the Options as a formatted string for use by the server to connect.
This may be the the ABL CONNECT statement or some other parameter.
specified by the property.
Parameters:
pcFormatMask CHARACTER
 
Returns CHARACTER
  character A useable string of connection parameters.
Top

CHARACTER GetConnectionString (FormatMaskEnum)

Purpose: Returns the Options as a formatted string for use by the server to connect.
This may be the the ABL CONNECT statement or some other parameter.
specified by the property.
Parameters:
poFormatMask OpenEdge.Core.ServerConnection.FormatMaskEnum
 
Returns CHARACTER
  character A useable string of connection parameters.
Top

CHARACTER GetConnectionString (JsonObject, character)

Purpose: Returns the Options as a formatted string for use by the server to connect.
This may be the the ABL CONNECT statement or some other parameter.
Parameters:
poOptions Progress.Json.ObjectModel.JsonObject
 
pcFormatMask CHARACTER
 
Returns CHARACTER
  character A useable string of connection parameters.
Top

Initialise ()

Purpose: Use this method for setting initial or default values, or other similar actions
Top

ShadowConstructor (JsonObject, FormatMaskEnum)

Purpose: Shadow constructor for this class. Used instead of a real constructor since some transformations
have to happen before its called, and since a constructor must be invoked first via SUPER or THIS-OBJECT,
there's no room for those transformations.
Parameters:
poOptions Progress.Json.ObjectModel.JsonObject
 
poFormatMask OpenEdge.Core.ServerConnection.FormatMaskEnum
 


Constructor Detail
Top

ConnectionParameters (character, FormatMaskEnum)

Parameters:
pcOptions CHARACTER
 
poFormatMask OpenEdge.Core.ServerConnection.FormatMaskEnum
 
Top

ConnectionParameters (JsonObject, FormatMaskEnum)

Parameters:
poOptions Progress.Json.ObjectModel.JsonObject
 
poFormatMask OpenEdge.Core.ServerConnection.FormatMaskEnum
 


Property Detail
Top

OpenEdge.Core.ServerConnection.FormatMaskEnum FormatMask
Top

Progress.Json.ObjectModel.JsonObject Options

Returns Progress.Json.ObjectModel.JsonObject
 
Top

CHARACTER ResolvedOptions

Returns CHARACTER
 


TitleResults for “How to create a CRG?”Also Available inAlert