DBCOLLATION function

Returns, as a character string, the name of the collating sequence for character set information contained in the database. This name corresponds to the definition of the collating sequence contained in the convmap.dat file, which usually resides in the $DLC directory. If any parameter is invalid, DBCOLLATION returns the Unknown value (?).

Syntax

DBCOLLATION
  ( {integer-expression|logical-name|alias} )

integer-expression

The sequence number of a database the ABL session is connected to. For example, DBCOLLATION(1) returns information on the first database the ABL session is connected to, DBCOLLATION(2) returns information on the second database the ABL session is connected to, etc. If you specify a sequence number that does not correspond to a database the ABL session is connected to, the DBCOLLATION function returns the Unknown value (?).

logical-name or alias

A character expression that specifies the database by its logical name or alias.

Example

This procedure displays the logical name and collation of all connected databases:

r-dbcoll.p

DEFINE VARIABLE ix AS INTEGER NO-UNDO
.
REPEAT ix = 1 TO NUM-DBS:
  DISPLAY LDBNAME(ix) DBCOLLATION(ix) FORMAT "x(19)".
END.

Notes

• OpenEdge and non-OpenEdge DataServers can evaluate the syntactical expression stated in a DBCOLLATION function. However, the methods used to process multiple byte code pages can differ based on the actual server used. Keep this point in mind if the actual results you receive differ from the results you expected.
• A database must be connected in order for the DBCOLLATION function to work as described.

See also

ALIAS function, CONNECT statement, CONNECTED function, CREATE ALIAS statement, CREATE CALL statement, DATASERVERS function, DBCODEPAGE function, DBRESTRICTIONS function, DBVERSION function, DELETE ALIAS statement, DISCONNECT statement, FRAME-DB function, LDBNAME function, NUM-DBS function, PDBNAME function, SDBNAME function