Configuration Manager
4-15
Initialization and Configuration
pOpenOrder
Pointer to array of tag values in initialization order
pCloseOrder
Pointer to array of tag values in shutdown order
Return Value
Returns zero on success, or less than 0 on an operation error. The possible
errors are:
CFGERROR_BADHANDLE
Invalid hCfg handle
CFGERROR_BADPARAM
Invalid function parameter
Description
The configuration API has no knowledge of the configuration database specifi-
cation. Thus, it has no concept of a priority in loading and unloading configura-
tion entries. The default order for both loading and unloading is by ascending
tag value.
An application may wish to specify the exact order in which entries should be
initialized ( specified in pOpenOrder) and shutdown (specified in pCloseOder).
Both arrays must be provided – even if they are identical pointers. The number
of elements in each array is specified by the Tags parameter. This must exactly
match the max number of tags in the system defined by CFGTAG_MAX. An
entry of 0 in either order array is used as a placeholder for tags that have not
yet been defined.
4.2.4
Configuration Entry API Functions
Remove a Reference to a Configuration Entry Handle
CfgEntryDeRef
Syntax
int CfgEntryDeRef( HANDLE hCfgEntry );
Parameter(s)
hCfgEntry
Handle to configuration entry
Return Value
Returns 0 on success, or less than 0 on an operation error. The possible errors
are:
CFGERROR_BADHANDLE
Invalid hCfgEntry handle
Description
This function removes a reference to the configuration entry handle supplied
in hCfgEntry. It is called by an application when it wishes to discard a refer-
enced configuration entry handle. Once this function is called, the handle
should no longer be used.