Other Library Functions

dbClose

function

Library: Database access (OMDB legacy)
Include: omdb.xin

Declaration 
define external function dbClose
       value dbDatabase database

Argument definitions

database
is a dbDatabase object obtained by opening a connection to a database using one of the dbOpen functions.


Purpose

Use dbClose to explicitly close an existing database connection. This has the effect of releasing any resources the database was using.

Requirements

You must include the following line at the beginning of your OmniMark program: 

  include "omdb.xin"

Usage Notes

A connection to a database will automatically close when the dbDatabase OMX variable you created goes out of scope. However, a global dbDatabase OMX variable will not go out of scope until the end of the program.

Closing an unopened dbDatabase object is allowed.

Closing a previously closed dbDatabase object is allowed.

Example:

Open a connection to a database and then close the connection. 

  include "omdb.xin"
  global dbDatabase my-database
  
  process
    set my-database to dbOpenODBC "DatabaseDemo"
    	. . .
    dbClose my-database

Other Library Functions