Database Configuration Client/Server High Level API

The client/server database configuration API module has the file name dbcscfg.c. This module provides a programmer with a high level callable API that will access the Bbuuzzb database server configuration details.

Any mention of QNX in this document refers to the QNX 4.x OS. The QNX platform version of this API uses QNX message passing as the interprocess communication method. All other platforms use the TCP socket interface to communicate to the database server. Note that there is no DOS version of this API.

This module contains the following global data:

- client log name or destination (dbcscfg_log_name)
- client log active flag (dbcscfg_log_flag)

Here is a list of functions in this module:

- 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
- db_config_client_init
- db_config_client_set_log
- db_config_client_set_log_flag
- db_config_client_get_log
- db_config_client_get_log_flag

# Module Dependencies

This module is part of the database client/server API and needs to be linked with the following modules:

- fio.c
- parse.c
- logger.c
- ipcomm.c (all platforms except QNX)
- sys_log.c
- slogcode.c
- sloc.c (all platforms except QNX)
- slconfig.c (all platforms except QNX)
- sliocode.c (all platforms except QNX)
- sconnect.c (all platforms except QNX)
- dbiocode.c
- dbcs.c

In the Linux/Unix/QNX platforms, this module is compiled along with the other database modules as part of the script cdbeng. A good example of a Unix script for a client application that uses this API is mkdbm.

# Module Header Files

This module depends on the following header files:

- stdhead.h
- dbmess.h
- dbcscfg.h

# Functions Unique to the Client/Server Database Configuration API

The following functions are unique to this module and are not present in the single user database configuration API.

## db_config_client_init

    Prototype  : void db_config_client_init(void)

This function will initialize the client global logging data.

## db_config_client_set_log

    Prototype  : int db_config_client_set_log(char *name)
    Parameters :
          Name : name
    Description: log name or destination

    Returns     : dbeng code

This function will set the client log name or destination.

## db_config_client_set_log_flag

    Prototype  : int db_config_client_set_log_flag(int flag)
    Parameters :
          Name : flag
    Description: client log flag

    Returns     : dbeng code

This function will set the client API logging flag. The client log flag must be one of TRUE or FALSE.

## db_config_client_get_log

    Prototype  : int db_config_client_get_log(char *name)
    Parameters :
          Name : name
    Description: returned log name or destination

    Returns     : dbeng code

This function will get and return the current log name or destination.

## db_config_client_get_log_flag

    Prototype  : int db_config_client_get_log_flag(int *flag)
    Parameters :
          Name : flag
    Description: returned client log flag

    Returns     : dbeng code

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

Goto Top | Future Lab Home | Contact Webmaster | Feedback

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