Module cli.pkg

***************************************************************************** *** CLI.PKG *** *** *** *** Author: Ben Weijers *** *** Data Access Nederland *** *** 10 September 1998 *** *** *** *** Purpose: *** *** CLI specific functionality. There are several connectivity kits *** *** based on SQL/92 CLI. Those are: *** *** - ODBC_DRV The Data Access CK for ODBC *** *** - DB2_DRV The Data Access CK for DB2 *** *** - MSSQLDRV The Data Access CK for Microsoft SQL Server *** *** *** *** This package defines the common functionality for all CLI based *** *** drivers. *** *** *** *** Updated: May 23rd 2008 (Current CK build: 5.0.0.53 ) *** *** Added NULLABLE and DEFAULT attributes for DATETIME type *** *** Updated: Apr 6th 2009 (Current CK build: 5.0.0.61 ) *** *** Added DF_DRIVER_MATCH_CLIENT_SERVER_VERSION attribute *** *** DF_DRIVER_SQLSERVER_CLIENT_VERSION attribute *** ***************************************************************************** *** We are not using ifndef below becuase that is not supported in Character Mode *** Driver attributes

cli.pkg (view source)
• StringCLI$StrDummy
• IntegerCLI$IntDummy
• CLI_SetConstraint
  ***************************************************************************** *** CLI_SetConstraint <FileNum> <NewState> *** *** *** *** Setup a constraint for a file. *** *****************************************************************************
• CLI_Get_Driver_Attribute
  ***************************************************************************** *** CLI_Set_Driver_Atrtribute / CLI_Get_Driver_Attribute *** *** *** *** Set or get an attribute at driver level. These attributes, when set, *** *** will be set for the remainder of the session or until set again. To *** *** permanently set driver level attributes change the driver *** *** configuration file. *** *****************************************************************************
• CLI_Set_Driver_Attribute
• CLI_Get_Database_Attribute
• cCLIHandler : Array
  ***************************************************************************** *** Class : cCLIHandler *** *** Purpose: An instance of this class can be used as a broker object to *** *** call several CLI releated methods. *** *****************************************************************************
  • Construct_Object(Integer iImage)
    • StringpsDriverID
  • StringCKRevision()
    *** *** Fucntion: CKRevsion *** Purpose : The revsion of a CLI Connectivity Kit ***
    • StringsDriverID
    • StringsRevision
    • StringsVoid
    • IntegeriRetval
  • IntegerExtractPartFromRevision(Integer iPartNum String sRevision)
    *** *** Function: ExtractPartFromRevision *** Purpose : Extarct the Nth part of a a.b.c.d revsion string. *** *** Returns : The part version number or -1 if there is no such part number. ***
    • IntegeriPartRev
    • IntegeriCurrentPart
    • IntegeriSeparatorPos
  • IntegerCKMajorRevision()
    *** *** Function: CKMajorRevision *** Purpose : Returns the major revision of the CK ***
  • IntegerCKMinorRevision()
    *** *** Function: CKMinorRevision *** Purpose : Returns the minor revision of the CK ***
  • IntegerCKReleaseRevision()
    *** *** Function: CKReleaseRevision *** Purpose : Returns the release revision of the CK ***
  • IntegerCKBuildRevision()
    *** *** Function: CKBuildRevision *** Purpose : Returns the major revision of the CK ***
  • IntegerIsMinimalRevision(Integer iMajor Integer iMinor Integer iRelease Integer iBuild)
    *** *** Function: IsMinimalRevision *** Purpose : Determines if the CK conforms to a passed minimal revsion. ***
  • StringRegistrationName()
    *** *** Function: RegistrationName *** Purpose : Returns the Connectiivty Kit registration name. ***
    • StringsRegistration
    • StringsDRiverId
    • StringsVoid
    • IntegeriRetval
  • IntegerSerialNumber()
    *** *** Function: SerialNumber *** Purpose : Returns the Connectiivty Kit serial number. ***
    • StringsDRiverId
    • StringsVoid
    • IntegeriRetval
  • IntegerMaxUsers()
    *** *** Function: MaxUsers *** Purpose : Returns the Connectiivty Kit maximum number of users. ***
    • StringsDRiverId
    • StringsVoid
    • IntegeriRetval
  • DumpStatus(String sFileName)
    *** *** Procedure: DumpStatus *** Purpose : Dump the current status of the drver in the passed disk file. ***
    • StringsVoid
    • StringsDriverID
    • IntegeriVoid
  • ReadConfiguration()
    *** *** Procedure: ReadConfiguration *** Purpose : Reset all driver level configurable attributes to the *** default value and then reread the configuration. ***
    • StringsVoid
    • StringsDriverID
    • IntegeriVoid
  • IntegerTextToRIMValue(String sText)
    *** *** Function: TextToRIMValue *** Purpose : Convert a text to the corresponding *** Generate_Record_ID_Method attribute value ***
  • StringRIMValueToText(Integer iAttrValue)
    *** *** Function: RIMValueTotext *** Purpose : Convert a Generate_Record_ID_Method attribute value to the *** corresponding text. ***
  • IntegerTextToROValue(String sText)
    *** *** Function: TextToROValue *** Purpose : Convert a text to the corresponding *** Generate_Record_ID_Method attribute value ***
  • StringROValueToText(Integer iAttrValue)
    *** *** Function: ROValueTotext *** Purpose : Convert a Generate_Record_ID_Method attribute value to the *** corresponding text. ***
  • StringLastDriverError()
    *** *** Function: LastDriverError *** Purpose : Return the text f the last error geneated by the driver. ***
    • StringsDriverID
    • StringsLastError
    • StringsLastErrorLength
    • IntegeriLastErrorLength
    • IntegeriVoid
  • IntegerEnumerateTables(String sLogin)
    *** *** Function: EnumerateTables *** Purpose : Enumerate the tables in a database ***
    • StringsDriver
    • StringsVoid
    • IntegeriNumTables
    • IntegeriVoid
  • StringTableName(Integer iIndex)
    *** *** Function: TableName *** Purpose : Returns the name of the table enumerated at the given position ***
    • StringsDriver
    • StringsTableName
    • StringsVoid
    • IntegeriVoid
  • StringSchemaName(Integer iIndex)
    *** *** Function: SchemaName *** Purpose : Returns the name of the schema of the table enumerated at the given position ***
    • StringsDriver
    • StringsSchemaName
    • StringsVoid
    • IntegeriVoid
  • StringTableType(Integer iIndex)
    *** *** Function: TableType *** Purpose : Returns the type of the table enumerated at the given position. *** Types can be "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", *** "LOCAL TEMPORARY", "ALIAS", "SYNONYM" ***
    • StringsDriver
    • StringsTableType
    • StringsVoid
    • IntegeriVoid
  • StringTableComment(Integer iIndex)
    *** *** Function: TableComment *** Purpose : Returns the comment of the table enumerated at the given position ***
    • StringsDriver
    • StringsTableComment
    • StringsVoid
    • IntegeriVoid
  • IntegerEnumerateColumns(String sLogin String sTableName)
    *** *** Function: EnumerateColumns *** Purpose : Enumerate the columns in a table ***
    • StringsDriver
    • IntegeriNumColumns
    • IntegeriVoid
  • StringColumnName(Integer iIndex)
    *** *** Function: ColumnName *** Purpose : Returns the name of the column enumerated at the given position ***
    • StringsDriver
    • StringsColumnName
    • StringsVoid
    • IntegeriVoid
  • StringCLIDFDateToSQLDate(String sDRiver Date dDFDate)
    *** *** Function: CLIDFDateToSQLDate *** Purpose : Convert a DataFlex date to a SQL date using the dummy zero date value. ***
    • StringsSQLDate
    • IntegeriOrgDateFmt
    • IntegeriOrgDateSep
  • DateCLISQLDateToDFDate(String sDRiver String sSQLDate)
    *** *** Function: CLISQLDateToDFDate *** Purpose : Convert a SQL date to a DataFlex date using the dummy zero date value. ***
    • DatedDFDate
    • StringsDummyDateValue
    • IntegeriOrgDateFmt
    • IntegeriOrgDateSep
  • IntegerRedirectConnection(String sOldConnection String sNewConnection)
    *** *** Function: RedirectConnection *** Purpose : Redirect an exisitng connection. The existing connection *** will point to another database but all tables will stay *** open! ***
    • StringsDriver
    • StringsVoid
    • IntegeriResult
    • IntegeriVoid
  • IntegerCreateConnectionID(String sID String sConnStr Integer iOpt)
    *** *** Function: CreateConnectionID *** Purpose : Create a DataFlex side connection id that can be used later on. ***
    • StringsDriver
    • IntegeriResult
    • IntegeriOptions
  • IntegerDeleteConnectionID(String sID Integer iIndex)
    *** *** Function: DeleteConnectionID *** Purpose : Delete a DataFlex side connection id. ***
    • StringsDriver
    • IntegeriResult
    • StringsVoid

References (1):

Field References (0):