isc_install_get_info()

From InterBase
Jump to: navigation, search

Go Up to API Function Reference


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

Syntax

MSG_NO isc_install_get_info(OPT option, int info_type, void *info_buf,
unsigned int buf_len)

Parameter Type Description

option

OPT

Option for which information is requested if info_type is 2 through 4; returns an error if option is not one of the following tokens:

  • IB_CONNECTIVITY_SERVER
  • IB_CLIENT
  • IB_CMD_TOOLS
  • IB_DEV
  • IB_DOC
  • IB_EXAMPLES
  • IB_EXAMPLE_API
  • IB_EXAMPLE_DB
  • IB_GUI_TOOLS
  • IB_JDBC
  • IB_JDBC_CLIENT
  • IB_JDBC_DOCS
  • IB_SERVER

See isc_install_set_option() for a description of each option.

<info_type>

int

Specifies the type of information requested; can be any one of the following values:

  • isc_install_info_destination returns a suggested destination and ignores any value passed for option
  • isc_install_info_opspace returns the disk space required to install a particular option; option requires a valid value
  • isc_install_info_opname returns a human-readable option name for the specified option; option requires a valid value
  • isc_install_info_opdescription returns a human-readable description for the specified option; option requires a valid value

<info_buf>

void*

isc_install_get_info() writes the requested information to this buffer, and returns an error if info_buf is NULL; if disk space information is requested, the result is an unsigned long

<buf_len>

unsigned int

The length in bytes of info_buf; returns an error if buf_len is NULL. Value should be at least isc_install_max_message_len bytes. If a destination suggestion is requested, the recommended buffer size is isc_install_max_path

Description

isc_install_get_info() returns the information requested by info_type into info_buf location. The info_buf and buf_len parameters cannot be NULL.

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.

The contents of info_buf are undetermined if isc_install_get_message() returns anything other than zero, so the caller should always check the return from this function.

Advance To: