SystemConfiguration

Describes the configuration of the c-tree Plus system.

Short Name

SYSCFG()

Type

Low-level function

Declaration

COUNT SystemConfiguration(pVOID bufptr)  

Description

SystemConfiguration returns an array of LONGs describing the c-tree Plus system configuration, as well as some of the important dynamic aspects of the system, such as the memory usage and the number of files in use. The number of elements in the array is given by ctCFGLMT, which defaults to 256.

To determine if a particular system configuration option is active, check to see if its corresponding array element is non-zero. For example, to determine if TRANPROC was turned on during system compilation, check element cfgTRANPROC of the configuration array to determine if it is non-zero.

The following configuration array subscripts correspond to dynamic system resources and are interpreted as noted:

The following array subscripts only apply to server implementations:

 The following array subscripts are static compile time values:

The subscripts displayed in this section and the pre-initialization resources section below have client and c-tree Server versions, except for the following three subscripts:

Subscripts ending with ‘app’ are specific to the client side of a client/server application. To check the same system setting for the c-tree Server, use the same subscript without the app extension. For example, to determine if Conditional Index support is active on the c-tree Server, use cfgCONDIDX as the subscript and cfgCONDIDXapp for the client side. On the client side, it is assumed the argument to SystemConfiguration is an array of properly aligned LONGs.

If SystemConfiguration is called for a non-client library, use the ‘app’ versions, i.e., cfgCONDIDXapp.

The pre-initialization resource subscripts below may be specified prior to a c-tree Plus initialization call, i.e., InitISAM, InitCTree, in addition to having both a client and c-tree Server version, as discussed above.

Pascal length byte - c-tree Plus supports two different methods for specifying the length byte in a pascal data type. The original and non-traditional approach does not include the length byte in the byte count. For example, with a 1-byte data type, CT_FPSTRING, the smallest valid length byte would be 0. The new method follows the more traditional pascal convention of including the length byte in the byte count. For example, with the traditional approach, the smallest valid length for a 1-byte data type would be 1. Therefore, if cfgPASCALstapp or cfgPASCAL24app return a non-zero value, the new traditional approach is active.

To receive a valid return value from cfgPATH_SEPARATOR, ctPATH_SEP must be defined. The default definition found in ctopt2.h is:

#define ctPATH_SEP   '?'

This definition specifies that the system default path separator will be used. To use the same separator for all platforms, you might want to choose one of the following:

#define ctPATH_SEP   '\\'

/* define for Windows, DOS and OS/2 */

#define ctPATH_SEP   '/' 

/* define for most Unix systems */

#define ctPATH_SEP   ':' 

/* define for Apple System 7 and PowerMac */

The following feature bitmaps are used with the cfgFEACHK element of the SystemConfiguration output array. When the bit is on, the corresponding feature is available. This is useful for client applications where the availability of a feature is not known at compile/link time. The current feature bit mask definitions are:

Note: An initial c-tree Plus call (InitCTree, InitCtreeXtd, InitISAM, etc.) must be made before SystemConfiguration can check on the cfgFEACHK element. The cfgINIT_CTREEapp element can be evaluated to determine the status of the c-tree Plus initialization.

For example:

  LONG       ca[ctCFGLMT];

SystemConfiguration(ca);

if (ca[cfgINIT_CTREEapp] == YES)

    printf("c-tree Plus Initialized");

else

    printf("c-tree Plus Uninitialized: %ld",

           ca(cfgINIT_CTREEapp));

/* where the Uninitialized value is NINT_ERR for a client or FINT_ERR for a bound application */

SystemConfiguration returns nine values referenced with the following constants used as subscripts in the output array of LONG values an application can use to capture system-wide cache and buffer statistics, (cache pages hold data record images and buffers hold index nodes), allowing an application to track the use of these resources.

Note: The dedicated cache pages are a subset of the regular cache pages.

Please see the following example for the use of this feature.

  LONG      ctcfg[ctCFGLMT];

SystemConfiguration(ctcfg);

printf(“\nAvailable Dedicated Cache Pages - %ld“,

       ctcfg[cfgCACHE_PAGES_DED]);

Return

See c-tree Plus Error Codes for a complete listing of valid c-tree Plus error values.

Example

  LONG      ctcfg[ctCFGLMT];       /* array of 256 longs */

SystemConfiguration(ctcfg);

printf("\nMemory Use is %ld\n", ctcfg[cfgMEMORY_USAGE]);

printf("Memory Highest is %ld\n", ctcfg[cfgMEMORY_HIGH]);

printf("Net allocation is %ld\n", ctcfg[cfgNET_ALLOCS]);

printf("Open Files level is %ld\n", ctcfg[cfgOPEN_FILES]);

printf("Physical Files is %ld\n", ctcfg[cfgPHYSICAL_FILES]);

printf("Open FCB's is %ld\n", ctcfg[cfgOPEN_FCBS]);

printf("ctLOGIDX support is %ld\n", ctcfg[cfgLOGIDX]);

See also

Functions InitISAM(), InitCTree(), InitCtreeXtd() and ctport.h utility.