Syntax
Description
Open a database. Returns ($db, $status).
Arguments
The path argument specifies the database filename.
The display argument may be specified to change the display mode for Ada, FORTRAN, Pascal, and JOVIAL. If it is not specified, the default, as stored in the database is used. Display must be one of the following:
- original - The case of all entities will be as originally specified in source code.
- upper - The case of all entities will be changed to all uppercase.
- lower - The case of all entities will be changed to all lowercase.
- first - The case of all entities will be changed so just the first character is capitalized.
- mixed - The case of all entities will be changed so the first character of each word is capitalized.
Return Values
$db is an object of the class Understand::Db.
If no error occurs, $status is undef. Otherwise, $status is:
Return Values
|
Description
|
DBAlreadyOpen
|
Only one database may be open at once
|
DBCorrupt
|
Sorry, bad database file
|
DBOldVersion
|
Database needs to be rebuilt
|
DBUnknownVersion
|
Database needs to be rebuilt
|
DBUnableOpen
|
Database is unreadable or does not exist
|
NoApiLicenseAda
|
Ada license required
|
NoApiLicenseC
|
C license required
|
NoApiLicenseFtn
|
FORTRAN license required
|
NoApiLicenseJava
|
Java license required
|
NoApiLicenseJovial
|
JOVIAL license required
|
NoApiLicensePascal
|
Pascal license required
|
Example
See Also
Opening a Database