ConnectionProperty

This function will return a characteristic of a data source. Some properties only refer to certain types of data connections. For example, dcDatabase would refer to an ODBC connection where dcHostPort would refer to a screen mapping connection. This is read-only.

Group:  System

Syntax:  vValue = SYS.ConnectionProperty(vSource, enProp)

vValue     (Variant) set to the value of the specified property

vSource   (Variant) is the string representation or the numeric representation of the database, screen mapping host or ERP session

enProp    (enDCProps) the following list of properties is available

dcAppGroup           (SAP)         Application Group field

dcAppName            (SM)           For Windows Console mode, this is the Applciation Executable field

dcAutoWrap            (SM)           Wrap text at end-of-line (VT220 only)

dcBackColor           (SM)           Back color of telnet emulator, it returns a numeric value corresponding to VB colors

dcBlockSize            (DB2)          Block Size field

dcCatalog               (DB2)          Initial Catalog field

dcCCSID                (DB2)          CCSID Conversion flag, returns a 0 (False) or a 1 (True)

dcCFIT                    (SAP)         Conversion Fault Character field

dcClientNo              (SAP)         Application server’s Client number

dcCmdLine             (SM)           For Windows Console mode, this is the Command Line field

dcCompany            (Dynamics) Company field

dcConfigFile           (ERP)         Axapta and Dynamics connections, this is the Configuration File field

dcConnCheck         (DB)           Validation Check field for all database connections. Returns a 0 (No) or a 1 (Yes)

dcConnectMode      (All)            Returns User Database, Enterprise Connection, Screen Mapping Connection, or Web Service

dcConnectTimeout  (Web)         Connect Timeout field

dcConnectType       (All)            Returns the type of connection. Values are: Access, Axapta, DB2, Dynamics, JDE Enterprise One, ODBC, OleDB, Oracle, SAP R/3, SQL Server, SQLite, TN3270, TN5250, VT220, Web Services, Windows Exe.

dcConnString          (DB)           Returns the provider string used to make the connection to the database. A portion of the string may be the path and file name of a file or one or more configuration fields combined together.

dcCursorType         (DB)           The cursor type or locking state used to make the connection (eg: Optimistic / Pessimistic)

dcDatabase            (DB)           For DB2 it is the Default Library field, for SQL Server it is the Database Name field.

dcDatabaseOwner                     (For future use)

dcDatabaseType     (DB)           For specific database types it returns the database name. For OleDB it returns the Database field value.

dcDataStream         (Other)        For SAP it returns the Data Format field, 0 (ASCII) or 1 (Unicode). For Screen Mapping, vt220 mode it returns the Data Stream field, 0 (Standard) or 1 (UTF-8)

dcDestructiveBS     (SM)           For VT220 only, it returns the Destructive Backspace Boolean check box option

dcDeviceName        (SM)           Device Name field for TN5250 and TN3270 only

dcDownTime           (All)            Returns the Schedule Downtime configuration for all data connector types.

dcDriver                                    (For future use)

dcDSN                   (DB)           For ODBC type only, it returns the Data Source field value.

dcEBCDIC              (SM)           Returns the Code Page field for TN5250 and TN3270 only

dcErrorCodes         (DB)           Reset on Error field values are returned for all database connector types.

dcExtendedProps   (DB)           Returns the Extended Properties list for all database connectors except ODBC.

dcFileName             (DB)           Returns the Database File name field value for Access, SQL Server and SQLite data connectors

dcFontSize             (SM)           Font Size field used to display the host screen in the telnet emulator or the HostScreen control for Windows Console mode.

dcForceKeyPacket  (SM)           For VT220 only, it returns the Send Whole Key Packets Boolean check box option

dcForeColor            (SM)           Display ForeColor used to display the host screen in the telnet emulator or the HostScreen control for Windows Console mode.

dcGWHost              (SAP)         Gateway Host field

dcGWService          (SAP)         Gateway Service field

dcIgnoreCert           (Web)         Ignore Invalid Certificates Boolean check box field

dcIndexDatabase    (DB)           Index Selected Databases Boolean check box field for all database connector types.

dcIndexList             (DB)           Tables Specified for Indexing list of values all database connector types.

dcIsJDE                 (DB)           Returns the JD Edwards Database Indexing Boolean check box on the Indexing Options tab for all database connector types.

dcLanguage            (SAP)         Returns the Language field, used to log in to the ERP system

dcLibraryList           (DB2)          Returns the Catelog Library List field value

dcLocale                 (SM)           Returns the numeric value of the Display Language field

dcLocalEcho           (SM)           For VT220 only, it returns the Echo Characters Locally Boolean check box option

dcLogicalName       (SQL Svr)   Returns the Logical Name field value for the SQL Server database type only

dcLoginMode          (All)            Returns Login Mode option on the Login Options tab (0 = Automatic, 1 = Manual)

dcMsgServer          (SAP)         Message Server field

dcOnCCE               (SAP)         returns the Character Conversion option (0 = Abort, 1 = Copy, 2 = Replace)

dcPackageName     (DB2)          Returns the SQL Package Name field value

dcPadFields           (SM)           For TN5250 and TN3270 only, returns the Pad fields When Sending Data Boolean check box value

dcPassword            (All)            Returns the Password field from most of the data connectors. Some data connector configurations do not have a password field.

dcPoolData            (All)            Returns the list or users and passwords in the Connection Pooling Named Users grid

dcPooled                (All)            Returns the Pooling Status field value (0 = Disabled, 1 = Enabled)

dcPoolMax             (All)            Returns the Allocated Licenses number

dcPort                    (SM)           For TN5250, TN3270, and VT220 only, this returns the Telnet Port field value

dcProvider              (DB)           Returns the Provider Name field value for database types that have one.

dcQueryGoal           (DB2)          Returns the Query Optimize Goal field value

dcQueryTimeOut     (DB)           Returns the Query Timeout value configured for any database connector

dcR3Name              (SAP)         R/3 Name field

dcReadDataRows   (ERP)         Maxium SQL Rows to be returned from the ERP connector

dcReceiveTimeout   (Web)         Returns the Receive Timeout field value

dcResetOnFailure                      (For future use)

dcRouter                 (SAP)         Router String field

dcSendCRLF          (SM)           For VT220 only, Returns Send Return + Line Feed Boolean field value

dcSendTimeout       (Web)         Send Timeout field

dcServer                 (All)            Returns the Host Server / Name field for any connector that has one

dcSessionTimeout   (All)            Returns the Session Timeout field for all connection types

dcSourceId             (All)            The Source Id field that names the connection

dcStartMenu           (SM)           Returns Session Default Main Menu option

dcStartMenuLocked (SM)           Returns 1 if the data connection is locked to a specific menu rather than the default of any main menu. This is found in the Login Options tab, Connection Pooling Named Users grid but only applies at runtime.

dcSystemDatabase                   (For future use)

dcSystemNo           (SAP)         System Number field

dcTraceMode          (SM)           Returns the Enable Packet Trace Boolean check box field value

dcTrimFields           (SM)           For TN5250 and TN3270 only, returns the Trim Fields When Retriving Data Boolean field value

dcTrusted                                 (For future use)

dcUseFile               (DB)           Returns 1 for SQLite and Access and SQL Server only if a file is selected instead of a database server.

dcUseHTTPS          (Web)         Returns the Connect Using HTTPS Boolean field value

dcUser                    (All)            Returns the User ID field for any connector that uses login credentials.

dcUseSSH              (SM)           For VT220 only, returns the Connect via SSH Boolean check box option

dcViewOwner          (DB)           Returns the Include Owner Name in Indexes Boolean check box field

dcViewSource         (DB)           Returns the Include Source Name in Indexes Boolean check box field

dcWinDomain         (ERP)         For Axapta and Dynamics only, returns the Windows Domain field

dcWinProxy            (ERP)         For Dynamics only, returns the Proxy Domain field

dcWinPwd              (ERP)         For Axapta and Dynamics only, returns the Proxy Password or Domain Password field

dcWinUser              (ERP)         For Axapta and Dynamics only, returns the Proxy User or Domain User field

dcWorkDir              (SM)           For the Windows Console Type only, returns the Working Directory field value.

Example:

Versions Supported:    RFgen 4.0 and newer.