isc_install_clear_options()

Go Up to API Function Reference

Clears all options set by isc_install_set_option().

Syntax

 MSG_NO isc_install_clear_options(OPTIONS_HANDLE *phandle)

Parameter	Type	Description
phandle	OPTIONS_HANDLE*	Pointer to the handle of the list of options for the current install You must initialize this to zero before first use Handle is maintained by the install engine; you do not need to and should not dereference it

Description

isc_install_clear_options() clears all the options and other install data stored in handle and sets handle to zero. It returns a warning if handle is already zero.

It is good practice to call this function both at the beginning and at the end of an install to free all resources. After calling isc_install_clear_options(), you must pass handle to isc_install_set_option() at least once before passing it to any of the other install functions.

Return value

If successful, isc_install_clear_options() returns isc_install_success. If the function completes, but with warnings, a number smaller than isc_install_success is returned. If a fatal error occurs, isc_install_clear_options() returns a number larger than isc_install_success.

Call isc_install_get_message() to obtain the error message when the result is not equal to isc_install_success.

Advance To:

• isc_install_execute()