Library Function Reference

The SQL preprocessor generates calls to functions in the interface library or DLL. In addition to the calls generated by the SQL preprocessor, a set of library functions is provided to make database operations easier to perform. Prototypes for these functions are included by the EXEC SQL INCLUDE SQLCA statement.

• alloc_sqlda Function
  Allocates a SQLDA with descriptors for numvar variables.
• alloc_sqlda_noind Function
  Allocates a SQLDA with descriptors for numvar variables.
• db_backup Function
  Although this function provides one way to add backup features to an application, the recommended way to do this task is to use the BACKUP DATABASE statement.
• db_cancel_request Function
  Cancels the currently active database server request. This function checks to make sure a database server request is active before sending the cancel request.
• db_change_char_charset Function
  Changes the application's CHAR character set for this connection.
• db_change_nchar_charset Function
  Changes the application's NCHAR character set for this connection.
• db_find_engine Function
  Returns status information about the local database server.
• db_fini Function
  This function frees resources used by the database interface or DLL.
• db_get_property Function
  Obtains information about the database interface or the server to which you are connected.
• db_init Function
  This function initializes the database interface library.
• db_is_working Function
  Returns 1 if your application has a database request in progress that uses the given sqlca and 0 if there is no request in progress that uses the given sqlca.
• db_locate_servers Function
  Provides programmatic access to the information displayed by the dblocate utility, listing all the SAP Sybase IQ database servers on the local network that are listening on TCP/IP.
• db_locate_servers_ex Function
  Provides programmatic access to the information displayed by the dblocate utility, listing all the SAP Sybase IQ database servers on the local network that are listening on TCP/IP, and provides a mask parameter used to select addresses passed to the callback function.
• db_register_a_callback Function
  This function registers callback functions.
• db_start_database Function
  Starts the database on an existing server, if possible. Otherwise, a new server is started.
• db_start_engine Function
  Starts the database server if it is not running.
• db_stop_database Function
  Stop the database identified by DatabaseName (DBN) on the server identified by ServerName (Server). If ServerName is not specified, the default server is used.
• db_stop_engine Function
  Stops execution of the database server.
• db_string_connect Function
  Provides extra functionality beyond the embedded SQL CONNECT statement.
• db_string_disconnect Function
  This function disconnects the connection identified by the ConnectionName parameter. All other parameters are ignored.
• db_string_ping_server Function
  This function can be used to determine if a server can be located, and optionally, if it a successful connection to a database can be made.
• db_time_change Function
  This function permits clients to notify the server that the time has changed on the client.
• fill_s_sqlda Function
  The same as fill_sqlda, except that it changes all the data types in sqlda to type DT_STRING.
• fill_sqlda Function
  Allocates space for each variable described in each descriptor of sqlda, and assigns the address of this memory to the sqldata field of the corresponding descriptor.
• fill_sqlda_ex Function
  Allocates space for each variable described in each descriptor of sqlda, and assigns the address of this memory to the sqldata field of the corresponding descriptor.
• free_filled_sqlda Function
  Free the memory allocated to each sqldata pointer and the space allocated for the SQLDA itself. Any null pointer is not freed.
• free_sqlda Function
  Free space allocated to this sqlda and free the indicator variable space, as allocated in fill_sqlda.
• free_sqlda_noind Function
  Free space allocated to this sqlda. Do not free the memory referenced by each sqldata pointer. The indicator variable pointers are ignored.
• sql_needs_quotes Function
  This function formulates a request to the database server to determine if quotes are needed. Relevant information is stored in the sqlcode field.
• sqlda_storage Function
  An unsigned 32-bit integer value representing the amount of storage required to store any value for the varno variable.
• sqlda_string_length Function
  Returns an unsigned 32-bit integer value representing the length of the C string (type DT_STRING) that would be required to hold the variable sqlda->sqlvar[varno] (no matter what its type is).
• sqlerror_message Function
  Returns a pointer to a string that contains an error message. The error message contains text for the error code in the SQLCA. If no error was indicated, a null pointer is returned. The error message is placed in the buffer supplied, truncated to length max if necessary.