isc_uninstall_precheck()

From InterBase

Go Up to API Function Reference


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

Syntax

 MSG_NO isc_uninstall_precheck(TEXT *uninstall_file_name)
Parameter Type Description

uninstall_file_name

TEXT *

A pointer to the name of the uninstall file that was created by isc_install_execute(); cannot be NULL.

Description

isc_uninstall_precheck() performs several checks to determine if an uninstall is possible. It checks:

  • That the operating system is valid (Windows only)
  • That the uninstall file (ib_uninst.nnn) is valid and contains the streamed list of options
  • That the server, if installed, is not running
  • That the user performing the uninstall is a member of either the administrator or poweruser groups on Windows server platforms; no equivalent check is performed on Windows non-server platforms.

Return value

Returns zero if the function executes successfully, a positive number if an error occurs, and a negative number if the function completes but with warnings. Call isc_install_get_message() to obtain the error message when the result is nonzero.

Advance To: