The Install API Functions

From InterBase
Jump to: navigation, search

Go Up to About the InterBase Install API


The InterBase Install API, ibinstall.dll, is a library of functions that facilitate the process of installing and deploying InterBase as part of the developer’s own application. Table 1.52, “Entry points in ibinstall.dll” lists each entry point in ibinstall.dll and gives a brief description.

Please see the API Function Reference topic for a detailed reference for each function.

Entry points in ibinstall.dll
Function Description

isc_install_clear_options()

Clears all options set by isc_install_set_option().

isc_install_execute()

Performs the actual install, including file copying, registry entries, saving uninstall options, and modifying the Services file if necessary.

isc_install_get_info()

Returns the requested information in human-readable form: a suggested install directory, required disk space, an option name, or option description.

isc_install_get_message()

Returns the text of the requested error or warning message number.

isc_install_load_external_text()

Loads the messages from the specified message file.

isc_install_precheck()

Performs a number of necessary checks on the install environment, such as checking for existing servers, disk space and access, user permissions, and option dependencies.

isc_install_set_option()

Creates a handle to a list of selected install options; must be called once for each option.

isc_install_unset_option()

Removes an option from the list of selected options obtained from isc_install_set_option().

isc_uninstall_execute()

Removes installed InterBase files, updates the registry, removes shares files that have a reference count less than 1, uninstalls the InterBase Guardian and Server services.

isc_uninstall_precheck()

Checks for a running server, correct user permission, and validity of the uninstall file.