tcsDbRoot.3

tcsDbRoot

Section: C Library Functions (3)
Updated: 2012-04-23 10:08
Index Return to man pages list

---

 

NAME

tcsDbRoot - Retrieve the "official" TCS database root point.

 

SYNOPSIS

const char* tcsDbRoot();

 

DESCRIPTION

Retrieves the "official" TCS database root point.
This database symbolic address must be used as an official root
point for all modules.
The default value for this address is defined in tcsDefines.h as:
              #define tcsDBPOINT_DEF ":Appl_data:TCS"
If the environment variable TCS_DBPOINT is set, it is used in place
of the default.

This function can be safely called only after ccsInit() has
been executed.

A standard TCS application, handling command line arguments via
the tcsMAIN_HANDLER(4) class should call this function
only after having called the Init() method of tcsMAIN_HANDLER(4)

A proper error handling makes sure that these rules are applied

This is a convenience function calling the static method:
                   tcsBASE::DbRoot()

 

ENVIRONMENT

  TCS_DBPOINT specifies the root point of the TCS database branch,
              if it is not the default.

 

RETURN VALUES

In case of error the function return NULL

 

CAUTIONS

This function can be safely called only after ccsInit() has
been executed.

A standard TCS application, handling command line arguments via
the tcsMAIN_HANDLER(4) class should call this function
only after having called the Init() method of tcsMAIN_HANDLER(4)

A proper error handling makes sure that these rules are applied

 

SEE ALSO

tcsBASE(4) tcsMAIN_HANDLER(4)

---

 

Index

NAME

SYNOPSIS

DESCRIPTION

ENVIRONMENT

RETURN VALUES

CAUTIONS

SEE ALSO

---

This document was created by man2html, using the manual pages.
Time: 10:08:47 GMT, April 23, 2012