isc_install_unset_option()

From InterBase

Go Up to API Function Reference


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

Syntax

 MSG_NO isc_install_unset_option(OPTIONS_HANDLE *phandle, OPT option)
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.

option

OPT

option can be any of the values listed for isc_install_set_option(). If option is the only member of the list, sets handle to zero.

Description

isc_install_unset_option() removes the option specified by option from the list maintained by handle. You must call this function once for each option to be removed. If handle is zero when this function is called, the function generates a warning.

Return value

Returns isc_install_success if the function executes successfully, a number larger than isc_install_success if an error occurs, and a number smaller than isc_install_success if the function completes but with warnings. Call isc_install_get_message() to obtain the error message when the result is not equal to isc_install_success.

Advance To: