isc_install_set_option()

From InterBase

Go Up to API Function Reference


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

Syntax

 MSG_NO isc_install_set_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. The handle is maintained by the install engine; you do not need to and should not dereference it.

option

OPT

option can be any one of the following values:

  • IB_SERVER installs the Server components of InterBase, consisting of the server, message file, Guardian, server configuration tools, gstat, UDF library, gds_lock_print/iblockpr, the international character set library, and the help files. IB_SERVER makes all necessary additions to the registry, creates the InterBase service, and adds gds_db to the Services file on Windows server platforms.
  • IB_CLIENT installs the InterBase client, including the client library and the message file, and makes Windows registry changes; adds the gds_db service, if necessary.
  • IB_CMD_TOOLS installs all the command line tools for InterBase on Windows platforms: gbak, gfix, gsec, gstat, iblockpr, and isql. It issues a warning if IB_CLIENT has not been specified.
  • IB_GUI_TOOLS installs IBConsole and its related help files; it issues a warning if the IB_CLIENT option has not been specified.
  • IB_JDBC installs the latest InterClient JDBC driver and associated documentation.
  • IB_JDBC_CLIENT installs the latest InterClient JDBC driver without documentation.
  • IB_JDBC_DOCS installs only the documentation for InterClient.
  • IB_DOC installs the InterBase documentation.
  • IB_EXAMPLES installs all InterBase examples (it has the same effect as specifying IB_EXAMPLE_API or IB_EXAMPLE_DB); it issues a warning if IB_SERVER, IB_CLIENT, and IB_DEV have not been specified.
  • IB_EXAMPLE_API installs API, SQL, DSQL, and ESQL example files; it issues a warning if IB_CLIENT and IB_DEV are not specified.
  • IB_EXAMPLE_DB installs all example databases; issues a warning if IB_SERVER has not been specified.
  • IB_DEV installs gpre, the import libraries, and the header files.

Description

isc_install_set_option() creates and maintains a handle to a list of requested option values. You must call isc_install_set_option() once for each option to be installed. In an interactive install, the function is typically invoked by a mouse click in a check box.

You must initialize handle to zero before calling isc_install_set_option() for the first time.

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: