Database High Level Configuration API

Many of the database configuration high level functions have the same name in the files dblocfg.c (single user) and dbcscfg.c (client/server). All the high level Bbuuzzb configuration functions have names that begin with:

       db_config_

Here is a list of functions that are common to both API's:

- db_config_get_tmp_path
- db_config_get_log
- db_config_get_session
- db_config_get_catalog
- db_config_get_log_flag
- db_config_get_session_flag
- db_config_get_catalog_flag
- db_config_get_replicate_flag
- db_config_get_version
- db_config_set_tmp_path
- db_config_set_log
- db_config_set_session
- db_config_set_catalog
- db_config_set_log_flag
- db_config_set_session_flag
- db_config_set_catalog_flag
- db_config_set_replicate_flag

# Module Functions

## db_config_get_tmp_path

    Prototype   : int db_config_get_tmp_path(char *path)
    Parameters  :
          Name  : path
    Description : returned path

    Returns     : dbeng code

This function will get and return the current temporary files path.

## db_config_get_log

    Prototype   : int db_config_get_log(char *slog)
    Parameters  :
          Name  : slog
    Description : returned log destination

    Returns     : dbeng code

This function will get and return the current log destination.

## db_config_get_session

    Prototype   : int db_config_get_session(char *ses_table)
    Parameters  :
          Name  : ses_table
    Description : returned session table name

    Returns     : dbeng code

This function will get and return the name of the current session table. Note that the session table is active only in client/server mode.

## db_config_get_catalog

    Prototype   : int db_config_get_catalog(char *cat)
    Parameters  :
          Name  : cat
    Description : returned catalog table name

    Returns     : dbeng code

This function will get and return the path/file name of the current catalog.

## db_config_get_log_flag

    Prototype   : int db_config_get_log_flag(int *flag)
    Parameters  :
          Name  : flag
    Description : returned log flag value

    Returns     : dbeng code

This function will get and return the current log flag value.

## db_config_get_session_flag

    Prototype   : int db_config_get_session_flag(int *flag)
    Parameters  :
          Name  : flag
    Description : returned session table flag value

    Returns     : dbeng code

This function will get and return the current session table flag value. Note that the session table flag is active only in client/server mode.

## db_config_get_catalog_flag

    Prototype   : int db_config_get_catalog_flag(int *flag)
    Parameters  :
          Name  : flag
    Description : returned catalog flag value

    Returns     : dbeng code

This function will get and return the current catalog flag value.

## db_config_get_replicate_flag

    Prototype   : int db_config_get_replicate_flag(int *flag)
    Parameters  :
          Name  : flag
    Description : returned replicate flag value

    Returns     : dbeng code

This function will get and return the current replicate flag value. Note that the replicate flag is active only in client/server mode.

## db_config_get_version

    Prototype   : int db_config_get_version(char *ver)
    Parameters  :
          Name  : ver
    Description : returned version string

    Returns     : dbeng code

This function will get and return the current Bbuuzzb version string. Note that this version applies only to the Bbuuzzb database engine. In addition, each Future Lab GPL application has its own version string.

## db_config_set_tmp_path

    Prototype   : int db_config_set_tmp_path(char *path)
    Parameters  :
          Name  : path
    Description : temporary files path

    Returns     : dbeng code

This function will set the current temporary files path. Note that the path supplied must be a valid directory that files can be written to (this will be checked).

## db_config_set_log

    Prototype   : int db_config_set_log(char *slog)
    Parameters  :
          Name  : slog
    Description : log destination

    Returns     : dbeng code

This function will set the Bbuuzzb engine log to the log destination. The log destination may be a path/file name or the system log server (support for the system log server in single user applications is optional and must be linked in).

## db_config_set_session

    Prototype   : int db_config_set_session(char *ses_table)
    Parameters  :
          Name  : ses_table
    Description : session table path/file name

    Returns     : dbeng code

This function will set the current session table to the session table path/file name which must point to a valid directory and file name that can be written to (this will be checked). If the session table does not already exist, it will be created. If the session table is changed while the session table is active, the contents of the previous session table will be lost. Note that the session table is active only in client/server mode.

## db_config_set_catalog

    Prototype   : int db_config_set_catalog(char *cat)
    Parameters  :
          Name  : cat
    Description : catalog path/file name

    Returns     : dbeng code

This function will set the catalog table to the catalog path/file name which must point to an existing file in a valid directory that can be read and written to (this will be checked). The catalog table must already exist and will not be automatically created by the Bbuuzzb engine.

## db_config_set_log_flag

    Prototype   : int db_config_set_log_flag(int flag)
    Parameters  :
          Name  : flag
    Description : log flag value

    Returns     : dbeng code

This function will set the log flag to the log flag value which must be either zero or one. This function will also turn logging on or off.

## db_config_set_session_flag

    Prototype   : int db_config_set_session_flag(int flag)
    Parameters  :
          Name  : flag
    Description : session table flag value

    Returns     : dbeng code

This function will set the session table flag to the session table flag value which must be either zero or one. Note that the session table is active only in client/server mode.

## db_config_set_catalog_flag

    Prototype   : int db_config_set_catalog_flag(int flag)
    Parameters  :
          Name  : flag
    Description : catalog flag value

    Returns     : dbeng code

This function will set the catalog flag to the catalog flag value which must be zero or one.

## db_config_set_replicate_flag

    Prototype   : int db_config_set_replicate_flag(int flag)
    Parameters  :
          Name  : flag
    Description : replicate flag value

    Returns     : dbeng code

This function will set the replicate flag to the replicate flag value which must be zero or one. Note that replication is active only in client/server mode.

Goto Top | Future Lab Home | Contact Webmaster | Feedback

Copyright © 1999-2006 Future Lab, Last Updated Jun 30, 2006