
Click above to get retro games delivered to your door ever month!
X-Hacker.org- Advantage CA-Clipper Guide v6.11 - ax_getconfiginfo()
[<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
AX_GetConfigInfo()
Returns Advantage Database Server configuration information
------------------------------------------------------------------------------
Syntax
AX_GetConfigInfo() -> array
Returns
Returns a two dimensional array of Advantage Database Server
configuration information. The length of the first dimension of the
returned 2-D array is two. The first element in the returned 2-D array
is an array of length 21 containing configuration values. The second
element in the returned 2-D array is an array of length 13 containing
the amount memory taken up by those configuration values that affect
memory. The 2-D array data consists of:
[1][1] = (numeric) Number of connections
[1][2] = (numeric) Number of work areas
[1][3] = (numeric) Number of tables
[1][4] = (numeric) Number of indexes
[1][5] = (numeric) Number of data locks
[1][6] = (numeric) User buffer size
[1][7] = (numeric) Statistics dump interval
[1][8] = (numeric) Maximum size of error log (in bytes)
[1][9] = (numeric) Number of Transaction List header elements
[1][10] = (numeric) Number of Transaction List table/index visibility
elements
[1][11] = (numeric) Number of Transaction List memo elements
[1][12] = (numeric) Number of receive ECBs (NetWare only)
[1][13] = (numeric) Number of send ECBs (NetWare only)
[1][14] = (numeric) Number of packets in a burst
[1][15] = (numeric) Number of worker threads
[1][16] = (numeric) Index sort buffer size
[1][17] = (string) Error log path
[1][18] = (string) Semaphore connection file path
[1][19] = (string) Transaction log file path
[1][20] = (numeric) Send IP port number
[1][21] = (numeric) Receive IP port number
[2][1] = (numeric) Total memory used by all configuration parameters
[2][2] = (numeric) Memory taken by connections
[2][3] = (numeric) Memory taken by work areas
[2][4] = (numeric) Memory taken by tables
[2][5] = (numeric) Memory taken by indexes
[2][6] = (numeric) Memory taken by data locks
[2][7] = (numeric) Memory taken by user buffer
[2][8] = (numeric) Memory taken by Transaction List header elements
[2][9] = (numeric) Memory taken by Transaction List visibility elements
[2][10] = (numeric) Memory taken by Transaction List memo elements
[2][11] = (numeric) Memory taken by receive ECBs (NetWare only)
[2][12] = (numeric) Memory taken by send ECBs (NetWare only)
[2][13] = (numeric) Memory taken by worker threads
- or -
Returns an empty array if an error occurred. If an error occurred,
AX_Error() will return information on why the function failed.
Description
When the Advantage Database Server is started/loaded, several values are
available to be configured to fine tune the use of the Advantage
Database Server. Many of these configurable parameters affect how much
server memory is used when the Advantage Database Server is started/
loaded. The remaining configurable parameters affect other non-memory
Advantage features.
AX_GetConfigInfo() returns a two dimensional array. The first element
in the returned 2-D array contains the current settings of all Advantage
Database Server configuration parameters. The second element in the
returned 2-D array contains the memory taken up by the applicable
configuration parameters. Each configuration memory array element
(i.e., array elements in the second array in the returned 2-D array)
contains the total memory (in bytes) taken up for each setting. To
determine how much memory is required per setting, divide the memory
size by the number configured.
Since it is possible that the number of elements in either the first or
the second second-dimensional array in the returned 2-D array will
increase in future releases of Advantage, it is highly recommended that
the length of each array be calculated using the Len() function, rather
than hard-coding the expected length to a literal value.
Example
// Must first get a connection to the Advantage Database Server
USE x:dummy.dbf VIA "DBFCDXAX"
aConfigInfo := AX_GetConfigInfo()
// Display the configuration values
for i := 1 to Len( aConfigInfo[1] )
? aConfigInfo[1][i]
next
// Display the memory taken by applicable configuration values
for i := 1 to Len( aConfigInfo[2] )
? aConfigInfo[2][i]
next
Online resources provided by: http://www.X-Hacker.org --- NG 2 HTML conversion by Dave Pearson