| Database Independent Abstraction Layer for C: libdbi Programmer's Guide | ||
|---|---|---|
| Prev | Chapter 7. libdbi API Reference | Next |
Enumerates all loaded drivers of the given instance. If Current is NULL, the first available driver will be returned. If Current is a valid driver, the next available driver will be returned.
Current: The current driver in the list of drivers, or NULL to retrieve the first one.
Inst: The instance handle.
The next available driver, or NULL if there is an error or no more are available.
0.9.0
Enumerates all loaded drivers. If Current is NULL, the first available driver will be returned. If Current is a valid driver, the next available driver will be returned.
Note: This function is deprecated. Use dbi_driver_list_r instead.
Current: The current driver in the list of drivers, or NULL to retrieve the first one.
The next available driver, or NULL if there is an error or no more are available.
Locate the driver with the specified name.
name: The name of the driver to open.
Inst: The instance handle.
The requested driver, or NULL if there is no such driver.
0.9.0
Locate the driver with the specified name.
Note: This function is deprecated. Use dbi_driver_open_r instead.
name: The name of the driver to open.
The requested driver, or NULL if there is no such driver.
Retrieves the handle of the instance that loaded the driver.
Driver: The target driver.
The instance handle, or NULL in case of an error.
0.9.0
Looks for the specified word in the list of reserved words. The result of this function may vary between databases. Case does not matter.
Driver: The target driver.
word: The word to check against the reserved word list.
-1 if an error occurs, 0 if the word is not reserved, 1 otherwise.
Returns a function pointer to the specifed custom function. This can be used to access database-specific functionality, but it will restrict your code to one particular database, lessening the benefits of using libdbi.
Driver: The target driver.
name: The name of the custom function.
If the custom function is found, a pointer to that function. If not, returns NULL.
0.9.0
Encloses the target string in the types of quotes that the database expects, and escapes any special characters. The original string will be freed and orig will point to a newly allocated one (which you still must free on your own). If an error occurs, the original string will not be freed.
Note: This function is deprecated. Use dbi_conn_quote_string instead.
Driver: The target driver.
orig: A pointer to the string to quote and escape.
The new string's length in bytes, excluding the terminating zero byte, or 0 in case of an error. The length of a quoted empty string is 2 bytes.
Encloses the target string in the types of quotes that the database expects, and escapes any special characters. The original string will be left alone, and newstr will point to a newly allocated string containing the quoted string (which you still must free on your own). In case of an error, newstr is an invalid pointer which you must not attempt to deallocate.
Note: This function is deprecated. Use dbi_conn_quote_string_copy instead.
Driver: The target driver.
orig: A pointer to the string to quote and escape.
newstr: After the function returns, this pointer will point to the quoted and escaped string.
The quoted string's length in bytes, excluding the terminating zero byte, or 0 in case of an error. The length of a quoted empty string is 2 bytes.
Requests the database engine specific name of the character encoding identified by its name as known to IANA. Use this function to pass the database engine specific encoding name to SQL queries , e.g. as part of a CREATE DATABASE command.
Driver: The target driver.
iana_encoding: The IANA name of the character encoding.
A string containing the database engine specific encoding name. If the encoding name cannot be translated, the IANA name is returned without translation.
0.8.0
Requests the IANA name of the character encoding identified by its database engine specific name. Use this function to convert the database engine specific name returned by SQL queries to the corresponding common name.
Driver: The target driver.
db_encoding: The database engine specific name of the character encoding.
A string containing the IANA encoding name. If the encoding name cannot be translated, the database engine specific name is returned without translation.
0.8.0
Requests the name of the specified driver. The calling program must not attempt to free the returned string.
Driver: The target driver.
A string containing the driver's name.
Requests the filename of the specified driver. The calling program must not attempt to free the returned string.
Driver: The target driver.
A string containing the driver's full path and file name.
Requests a description of the specified driver. The calling program must not attempt to free the returned string.
Driver: The target driver.
A string containing the driver's description. It will be one or two short sentences with no newlines.
Requests the maintainer of the specified driver. The calling program must not attempt to free the returned string.
Driver: The target driver.
A string containing the driver maintainer's full name and email address.
Requests the maintainer's URL for the specified driver. This is useful for drivers maintained by a third party. The calling program must not attempt to free the returned string.
Driver: The target driver.
Requests the version of the specified driver. The calling program must not attempt to free the returned string.
Driver: The target driver.
A string containing the driver's version.
Requests the compilation date of the specified driver. The calling program must not attempt to free the returned string.
Driver: The target driver.
A string containing the date the driver was compiled.
Requests the value of the driver capability which is specified as an argument.
Driver: The target driver.
capname: A pointer to a string containing the name of the driver capability to be queried.
The numeric value of the driver capability.