Advantage Client Engine
Returns Advantage Database Server configuration information
UNSIGNED32 |
AdsMgGetConfigInfo ( ADSHANDLE hMgmtConnect, ADS_MGMT_CONFIG_PARAMS *pstConfigValues, UNSIGNED16 *pusConfigValuesStructSize, ADS_MGMT_CONFIG_MEMORY *pstConfigMemory, UNSIGNED16 *pusConfigMemoryStructSize ); |
hMgmtConnect (I) |
Management API connection handle of server to get configuration information. |
pstConfigValues (O) |
Returned configuration parameter value structure. |
pusConfigValueStructSize (I/O) |
Size (in bytes) of pstConfigValues structure on input. On output, size (in bytes) of data returned. |
pstConfigMemory (O) |
Returned configuration parameter memory structure. |
pusConfigMemoryStructSize (I/O) |
Size (in bytes) of pstConfigMemory structure on input. On output, size (in bytes) of data returned. |
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. AdsMgGetConfigInfo returns two structures. The first, pstConfigValues, contains the current settings of all Advantage Database Server configuration parameters. The second, pstConfigMemory, contains the memory taken up by the applicable configuration parameters. Each pstConfigMemory structure data member 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 size of the ADS_MGMT_CONFIG_PARAMS and/or ADS_MGMT_CONFIG_MEMORY structures will increase in future releases of Advantage, it is highly recommended that on input the pusConfigValueStructSize and pusConfigMemoryStructSize parameters are literally initialized with sizeof( ADS_MGMT_CONFIG_PARAMS ) and sizeof( ADS_MGMT_CONFIG_MEMORY ), respectively, rather than being initialized with literal values.
Note With the Advantage Local Server, AdsMgGetConfigInfo will only return information for the instance of Advantage Local Server currently loaded into memory.