<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <HTML ><HEAD ><TITLE >libdbi API Reference</TITLE ><META NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK REL="HOME" TITLE="Database Independent Abstraction Layer for C" HREF="index.html"><LINK REL="PREVIOUS" TITLE="Error numbers" HREF="errornumbers.html"><LINK REL="NEXT" TITLE="Core Library Functions" HREF="reference-core.html"></HEAD ><BODY CLASS="CHAPTER" BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#840084" ALINK="#0000FF" ><DIV CLASS="NAVHEADER" ><TABLE SUMMARY="Header navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TH COLSPAN="3" ALIGN="center" >Database Independent Abstraction Layer for C: libdbi Programmer's Guide</TH ></TR ><TR ><TD WIDTH="10%" ALIGN="left" VALIGN="bottom" ><A HREF="errornumbers.html" ACCESSKEY="P" >Prev</A ></TD ><TD WIDTH="80%" ALIGN="center" VALIGN="bottom" ></TD ><TD WIDTH="10%" ALIGN="right" VALIGN="bottom" ><A HREF="reference-core.html" ACCESSKEY="N" >Next</A ></TD ></TR ></TABLE ><HR ALIGN="LEFT" WIDTH="100%"></DIV ><DIV CLASS="CHAPTER" ><H1 ><A NAME="REFERENCE" ></A >Chapter 4. libdbi API Reference</H1 ><DIV CLASS="TOC" ><DL ><DT ><B >Table of Contents</B ></DT ><DT >4.1. <A HREF="reference-core.html" >Core Library Functions</A ></DT ><DD ><DL ><DT >4.1.1. <A HREF="reference-core.html#DBI-INITIALIZE" >dbi_initialize</A ></DT ><DT >4.1.2. <A HREF="reference-core.html#DBI-SHUTDOWN" >dbi_shutdown</A ></DT ><DT >4.1.3. <A HREF="reference-core.html#DBI-VERSION" >dbi_version</A ></DT ></DL ></DD ><DT >4.2. <A HREF="reference-driver.html" >Driver Infrastructure</A ></DT ><DD ><DL ><DT >4.2.1. <A HREF="reference-driver.html#DBI-DRIVER-LIST" >dbi_driver_list</A ></DT ><DT >4.2.2. <A HREF="reference-driver.html#DBI-DRIVER-OPEN" >dbi_driver_open</A ></DT ><DT >4.2.3. <A HREF="reference-driver.html#DBI-DRIVER-IS-RESERVED-WORD" >dbi_driver_is_reserved_word</A ></DT ><DT >4.2.4. <A HREF="reference-driver.html#DBI-DRIVER-SPECIFIC-FUNCTION" >dbi_driver_specific_function</A ></DT ><DT >4.2.5. <A HREF="reference-driver.html#DBI-DRIVER-QUOTE-STRING" >dbi_driver_quote_string</A ></DT ><DT >4.2.6. <A HREF="reference-driver.html#DBI-DRIVER-QUOTE-STRING-COPY" >dbi_driver_quote_string_copy</A ></DT ><DT >4.2.7. <A HREF="reference-driver.html#DBI-DRIVER-ENCODING-FROM-IANA" >dbi_driver_encoding_from_iana</A ></DT ><DT >4.2.8. <A HREF="reference-driver.html#DBI-DRIVER-ENCODING-TO-IANA" >dbi_driver_encoding_to_iana</A ></DT ><DT >4.2.9. <A HREF="reference-driver.html#REFERENCE-DRIVER-INFO" >Driver Information</A ></DT ><DD ><DL ><DT >4.2.9.1. <A HREF="reference-driver.html#DBI-DRIVER-GET-NAME" >dbi_driver_get_name</A ></DT ><DT >4.2.9.2. <A HREF="reference-driver.html#DBI-DRIVER-GET-FILENAME" >dbi_driver_get_filename</A ></DT ><DT >4.2.9.3. <A HREF="reference-driver.html#DBI-DRIVER-GET-DESCRIPTION" >dbi_driver_get_description</A ></DT ><DT >4.2.9.4. <A HREF="reference-driver.html#DBI-DRIVER-GET-MAINTAINER" >dbi_driver_get_maintainer</A ></DT ><DT >4.2.9.5. <A HREF="reference-driver.html#DBI-DRIVER-GET-URL" >dbi_driver_get_url</A ></DT ><DT >4.2.9.6. <A HREF="reference-driver.html#DBI-DRIVER-GET-VERSION" >dbi_driver_get_version</A ></DT ><DT >4.2.9.7. <A HREF="reference-driver.html#DBI-DRIVER-GET-DATE-COMPILED" >dbi_driver_get_date_compiled</A ></DT ></DL ></DD ></DL ></DD ><DT >4.3. <A HREF="reference-conn.html" >Connection Infrastructure</A ></DT ><DD ><DL ><DT >4.3.1. <A HREF="reference-conn.html#DBI-CONN-NEW" >dbi_conn_new</A ></DT ><DT >4.3.2. <A HREF="reference-conn.html#DBI-CONN-OPEN" >dbi_conn_open</A ></DT ><DT >4.3.3. <A HREF="reference-conn.html#DBI-CONN-CLOSE" >dbi_conn_close</A ></DT ><DT >4.3.4. <A HREF="reference-conn.html#DBI-CONN-GET-DRIVER" >dbi_conn_get_driver</A ></DT ><DT >4.3.5. <A HREF="reference-conn.html#DBI-CONN-SET-OPTION" >dbi_conn_set_option</A ></DT ><DT >4.3.6. <A HREF="reference-conn.html#DBI-CONN-SET-OPTION-NUMERIC" >dbi_conn_set_option_numeric</A ></DT ><DT >4.3.7. <A HREF="reference-conn.html#DBI-CONN-GET-OPTION" >dbi_conn_get_option</A ></DT ><DT >4.3.8. <A HREF="reference-conn.html#DBI-CONN-REQUIRE-OPTION" >dbi_conn_require_option</A ></DT ><DT >4.3.9. <A HREF="reference-conn.html#DBI-CONN-GET-OPTION-NUMERIC" >dbi_conn_get_option_numeric</A ></DT ><DT >4.3.10. <A HREF="reference-conn.html#DBI-CONN-REQUIRE-OPTION-NUMERIC" >dbi_conn_require_option_numeric</A ></DT ><DT >4.3.11. <A HREF="reference-conn.html#DBI-CONN-GET-OPTION-LIST" >dbi_conn_get_option_list</A ></DT ><DT >4.3.12. <A HREF="reference-conn.html#DBI-CONN-CLEAR-OPTION" >dbi_conn_clear_option</A ></DT ><DT >4.3.13. <A HREF="reference-conn.html#DBI-CONN-CLEAR-OPTIONS" >dbi_conn_clear_options</A ></DT ><DT >4.3.14. <A HREF="reference-conn.html#DBI-CONN-GET-SOCKET" >dbi_conn_get_socket</A ></DT ><DT >4.3.15. <A HREF="reference-conn.html#DBI-CONN-GET-ENCODING" >dbi_conn_get_encoding</A ></DT ><DT >4.3.16. <A HREF="reference-conn.html#DBI-CONN-GET-ENGINE-VERSION-STRING" >dbi_conn_get_engine_version_string</A ></DT ><DT >4.3.17. <A HREF="reference-conn.html#DBI-CONN-GET-ENGINE-VERSION" >dbi_conn_get_engine_version</A ></DT ><DT >4.3.18. <A HREF="reference-conn.html#REFERENCE-CONN-ERROR" >Error Handling</A ></DT ><DD ><DL ><DT >4.3.18.1. <A HREF="reference-conn.html#DBI-CONN-ERROR" >dbi_conn_error</A ></DT ><DT >4.3.18.2. <A HREF="reference-conn.html#DBI-CONN-ERROR-HANDLER" >dbi_conn_error_handler</A ></DT ><DT >4.3.18.3. <A HREF="reference-conn.html#DBI-CONN-ERROR-FLAG" >dbi_conn_error_flag</A ></DT ><DT >4.3.18.4. <A HREF="reference-conn.html#DBI-CONN-SET-ERROR" >dbi_conn_set_error</A ></DT ></DL ></DD ></DL ></DD ><DT >4.4. <A HREF="reference-database.html" >SQL and Database Infrastructure</A ></DT ><DD ><DL ><DT >4.4.1. <A HREF="reference-database.html#DBI-CONN-CONNECT" >dbi_conn_connect</A ></DT ><DT >4.4.2. <A HREF="reference-database.html#DBI-CONN-GET-DB-LIST" >dbi_conn_get_db_list</A ></DT ><DT >4.4.3. <A HREF="reference-database.html#DBI-CONN-GET-TABLE-LIST" >dbi_conn_get_table_list</A ></DT ><DT >4.4.4. <A HREF="reference-database.html#DBI-CONN-SELECT-DB" >dbi_conn_select_db</A ></DT ></DL ></DD ><DT >4.5. <A HREF="reference-query.html" >Managing Queries</A ></DT ><DD ><DL ><DT >4.5.1. <A HREF="reference-query.html#DBI-CONN-QUERY" >dbi_conn_query</A ></DT ><DT >4.5.2. <A HREF="reference-query.html#DBI-CONN-QUERYF" >dbi_conn_queryf</A ></DT ><DT >4.5.3. <A HREF="reference-query.html#DBI-CONN-QUERY-NULL" >dbi_conn_query_null</A ></DT ><DT >4.5.4. <A HREF="reference-query.html#DBI-CONN-SEQUENCE-LAST" >dbi_conn_sequence_last</A ></DT ><DT >4.5.5. <A HREF="reference-query.html#DBI-CONN-SEQUENCE-NEXT" >dbi_conn_sequence_next</A ></DT ><DT >4.5.6. <A HREF="reference-query.html#DBI-CONN-PING" >dbi_conn_ping</A ></DT ><DT >4.5.7. <A HREF="reference-query.html#DBI-CONN-QUOTE-STRING" >dbi_conn_quote_string</A ></DT ><DT >4.5.8. <A HREF="reference-query.html#DBI-CONN-QUOTE-STRING-COPY" >dbi_conn_quote_string_copy</A ></DT ><DT >4.5.9. <A HREF="reference-query.html#DBI-CONN-QUOTE-BINARY-COPY" >dbi_conn_quote_binary_copy</A ></DT ><DT >4.5.10. <A HREF="reference-query.html#DBI-CONN-ESCAPE-STRING" >dbi_conn_escape_string</A ></DT ><DT >4.5.11. <A HREF="reference-query.html#DBI-CONN-ESCAPE-STRING-COPY" >dbi_conn_escape_string_copy</A ></DT ><DT >4.5.12. <A HREF="reference-query.html#DBI-CONN-ESCAPE-BINARY-COPY" >dbi_conn_escape_binary_copy</A ></DT ></DL ></DD ><DT >4.6. <A HREF="reference-results.html" >Managing Results</A ></DT ><DD ><DL ><DT >4.6.1. <A HREF="reference-results.html#DBI-RESULT-GET-CONN" >dbi_result_get_conn</A ></DT ><DT >4.6.2. <A HREF="reference-results.html#DBI-RESULT-FREE" >dbi_result_free</A ></DT ><DT >4.6.3. <A HREF="reference-results.html#DBI-RESULT-SEEK-ROW" >dbi_result_seek_row</A ></DT ><DT >4.6.4. <A HREF="reference-results.html#DBI-RESULT-FIRST-ROW" >dbi_result_first_row</A ></DT ><DT >4.6.5. <A HREF="reference-results.html#DBI-RESULT-LAST-ROW" >dbi_result_last_row</A ></DT ><DT >4.6.6. <A HREF="reference-results.html#DBI-RESULT-PREV-ROW" >dbi_result_prev_row</A ></DT ><DT >4.6.7. <A HREF="reference-results.html#DBI-RESULT-NEXT-ROW" >dbi_result_next_row</A ></DT ><DT >4.6.8. <A HREF="reference-results.html#DBI-RESULT-GET-CURROW" >dbi_result_get_currow</A ></DT ><DT >4.6.9. <A HREF="reference-results.html#DBI-RESULT-GET-NUMROWS" >dbi_result_get_numrows</A ></DT ><DT >4.6.10. <A HREF="reference-results.html#DBI-RESULT-GET-NUMROWS-AFFECTED" >dbi_result_get_numrows_affected</A ></DT ></DL ></DD ><DT >4.7. <A HREF="reference-field-meta.html" >Retrieving Field Meta-data</A ></DT ><DD ><DL ><DT >4.7.1. <A HREF="reference-field-meta.html#DBI-RESULT-GET-FIELD-LENGTH" >dbi_result_get_field_length</A ></DT ><DT >4.7.2. <A HREF="reference-field-meta.html#DBI-RESULT-GET-FIELD-LENGTH-IDX" >dbi_result_get_field_length_idx</A ></DT ><DT >4.7.3. <A HREF="reference-field-meta.html#DBI-RESULT-GET-FIELD-SIZE" >dbi_result_get_field_size</A ></DT ><DT >4.7.4. <A HREF="reference-field-meta.html#DBI-RESULT-GET-FIELD-SIZE-IDX" >dbi_result_get_field_size_idx</A ></DT ><DT >4.7.5. <A HREF="reference-field-meta.html#DBI-RESULT-GET-FIELD-IDX" >dbi_result_get_field_idx</A ></DT ><DT >4.7.6. <A HREF="reference-field-meta.html#DBI-RESULT-GET-FIELD-NAME" >dbi_result_get_field_name</A ></DT ><DT >4.7.7. <A HREF="reference-field-meta.html#DBI-RESULT-GET-NUMFIELDS" >dbi_result_get_numfields</A ></DT ><DT >4.7.8. <A HREF="reference-field-meta.html#DBI-RESULT-GET-FIELD-TYPE" >dbi_result_get_field_type</A ></DT ><DT >4.7.9. <A HREF="reference-field-meta.html#DBI-RESULT-GET-FIELD-TYPE-IDX" >dbi_result_get_field_type_idx</A ></DT ><DT >4.7.10. <A HREF="reference-field-meta.html#DBI-RESULT-GET-FIELD-ATTRIB" >dbi_result_get_field_attrib</A ></DT ><DT >4.7.11. <A HREF="reference-field-meta.html#DBI-RESULT-GET-FIELD-ATTRIB-IDX" >dbi_result_get_field_attrib_idx</A ></DT ><DT >4.7.12. <A HREF="reference-field-meta.html#DBI-RESULT-GET-FIELD-ATTRIBS" >dbi_result_get_field_attribs</A ></DT ><DT >4.7.13. <A HREF="reference-field-meta.html#DBI-RESULT-GET-FIELD-ATTRIBS-IDX" >dbi_result_get_field_attribs_idx</A ></DT ><DT >4.7.14. <A HREF="reference-field-meta.html#DBI-RESULT-FIELD-IS-NULL" >dbi_result_field_is_null</A ></DT ><DT >4.7.15. <A HREF="reference-field-meta.html#DBI-RESULT-FIELD-IS-NULL-IDX" >dbi_result_field_is_null_idx</A ></DT ></DL ></DD ><DT >4.8. <A HREF="reference-field.html" >Retrieving Field Data by Name</A ></DT ><DD ><DL ><DT >4.8.1. <A HREF="reference-field.html#DBI-RESULT-GET-FIELDS" >dbi_result_get_fields</A ></DT ><DT >4.8.2. <A HREF="reference-field.html#DBI-RESULT-BIND-FIELDS" >dbi_result_bind_fields</A ></DT ><DT >4.8.3. <A HREF="reference-field.html#DBI-RESULT-GET-CHAR" >dbi_result_get_char</A ></DT ><DT >4.8.4. <A HREF="reference-field.html#DBI-RESULT-GET-UCHAR" >dbi_result_get_uchar</A ></DT ><DT >4.8.5. <A HREF="reference-field.html#DBI-RESULT-GET-SHORT" >dbi_result_get_short</A ></DT ><DT >4.8.6. <A HREF="reference-field.html#DBI-RESULT-GET-USHORT" >dbi_result_get_ushort</A ></DT ><DT >4.8.7. <A HREF="reference-field.html#DBI-RESULT-GET-INT" >dbi_result_get_int</A ></DT ><DT >4.8.8. <A HREF="reference-field.html#DBI-RESULT-GET-UINT" >dbi_result_get_uint</A ></DT ><DT >4.8.9. <A HREF="reference-field.html#DBI-RESULT-GET-LONG" >dbi_result_get_long</A ></DT ><DT >4.8.10. <A HREF="reference-field.html#DBI-RESULT-GET-ULONG" >dbi_result_get_ulong</A ></DT ><DT >4.8.11. <A HREF="reference-field.html#DBI-RESULT-GET-LONGLONG" >dbi_result_get_longlong</A ></DT ><DT >4.8.12. <A HREF="reference-field.html#DBI-RESULT-GET-ULONGLONG" >dbi_result_get_ulonglong</A ></DT ><DT >4.8.13. <A HREF="reference-field.html#DBI-RESULT-GET-FLOAT" >dbi_result_get_float</A ></DT ><DT >4.8.14. <A HREF="reference-field.html#DBI-RESULT-GET-DOUBLE" >dbi_result_get_double</A ></DT ><DT >4.8.15. <A HREF="reference-field.html#DBI-RESULT-GET-STRING" >dbi_result_get_string</A ></DT ><DT >4.8.16. <A HREF="reference-field.html#DBI-RESULT-GET-STRING-COPY" >dbi_result_get_string_copy</A ></DT ><DT >4.8.17. <A HREF="reference-field.html#DBI-RESULT-GET-BINARY" >dbi_result_get_binary</A ></DT ><DT >4.8.18. <A HREF="reference-field.html#DBI-RESULT-GET-BINARY-COPY" >dbi_result_get_binary_copy</A ></DT ><DT >4.8.19. <A HREF="reference-field.html#DBI-RESULT-GET-DATETIME" >dbi_result_get_datetime</A ></DT ><DT >4.8.20. <A HREF="reference-field.html#DBI-RESULT-BIND-CHAR" >dbi_result_bind_char</A ></DT ><DT >4.8.21. <A HREF="reference-field.html#DBI-RESULT-BIND-UCHAR" >dbi_result_bind_uchar</A ></DT ><DT >4.8.22. <A HREF="reference-field.html#DBI-RESULT-BIND-SHORT" >dbi_result_bind_short</A ></DT ><DT >4.8.23. <A HREF="reference-field.html#DBI-RESULT-BIND-USHORT" >dbi_result_bind_ushort</A ></DT ><DT >4.8.24. <A HREF="reference-field.html#DBI-RESULT-BIND-INT" >dbi_result_bind_int</A ></DT ><DT >4.8.25. <A HREF="reference-field.html#DBI-RESULT-BIND-UINT" >dbi_result_bind_uint</A ></DT ><DT >4.8.26. <A HREF="reference-field.html#DBI-RESULT-BIND-LONG" >dbi_result_bind_long</A ></DT ><DT >4.8.27. <A HREF="reference-field.html#DBI-RESULT-BIND-ULONG" >dbi_result_bind_ulong</A ></DT ><DT >4.8.28. <A HREF="reference-field.html#DBI-RESULT-BIND-LONGLONG" >dbi_result_bind_longlong</A ></DT ><DT >4.8.29. <A HREF="reference-field.html#DBI-RESULT-BIND-ULONGLONG" >dbi_result_bind_ulonglong</A ></DT ><DT >4.8.30. <A HREF="reference-field.html#DBI-RESULT-BIND-FLOAT" >dbi_result_bind_float</A ></DT ><DT >4.8.31. <A HREF="reference-field.html#DBI-RESULT-BIND-DOUBLE" >dbi_result_bind_double</A ></DT ><DT >4.8.32. <A HREF="reference-field.html#DBI-RESULT-BIND-STRING" >dbi_result_bind_string</A ></DT ><DT >4.8.33. <A HREF="reference-field.html#DBI-RESULT-BIND-BINARY" >dbi_result_bind_binary</A ></DT ><DT >4.8.34. <A HREF="reference-field.html#DBI-RESULT-BIND-STRING-COPY" >dbi_result_bind_string_copy</A ></DT ><DT >4.8.35. <A HREF="reference-field.html#DBI-RESULT-BIND-BINARY-COPY" >dbi_result_bind_binary_copy</A ></DT ><DT >4.8.36. <A HREF="reference-field.html#DBI-RESULT-BIND-DATETIME" >dbi_result_bind_datetime</A ></DT ></DL ></DD ><DT >4.9. <A HREF="reference-field-idx.html" >Retrieving Field Data by Index</A ></DT ><DD ><DL ><DT >4.9.1. <A HREF="reference-field-idx.html#DBI-RESULT-GET-CHAR-IDX" >dbi_result_get_char_idx</A ></DT ><DT >4.9.2. <A HREF="reference-field-idx.html#DBI-RESULT-GET-UCHAR-IDX" >dbi_result_get_uchar_idx</A ></DT ><DT >4.9.3. <A HREF="reference-field-idx.html#DBI-RESULT-GET-SHORT-IDX" >dbi_result_get_short_idx</A ></DT ><DT >4.9.4. <A HREF="reference-field-idx.html#DBI-RESULT-GET-USHORT-IDX" >dbi_result_get_ushort_idx</A ></DT ><DT >4.9.5. <A HREF="reference-field-idx.html#DBI-RESULT-GET-INT-IDX" >dbi_result_get_int_idx</A ></DT ><DT >4.9.6. <A HREF="reference-field-idx.html#DBI-RESULT-GET-UINT-IDX" >dbi_result_get_uint_idx</A ></DT ><DT >4.9.7. <A HREF="reference-field-idx.html#DBI-RESULT-GET-LONG-IDX" >dbi_result_get_long_idx</A ></DT ><DT >4.9.8. <A HREF="reference-field-idx.html#DBI-RESULT-GET-ULONG-IDX" >dbi_result_get_ulong_idx</A ></DT ><DT >4.9.9. <A HREF="reference-field-idx.html#DBI-RESULT-GET-LONGLONG-IDX" >dbi_result_get_longlong_idx</A ></DT ><DT >4.9.10. <A HREF="reference-field-idx.html#DBI-RESULT-GET-ULONGLONG-IDX" >dbi_result_get_ulonglong_idx</A ></DT ><DT >4.9.11. <A HREF="reference-field-idx.html#DBI-RESULT-GET-FLOAT-IDX" >dbi_result_get_float_idx</A ></DT ><DT >4.9.12. <A HREF="reference-field-idx.html#DBI-RESULT-GET-DOUBLE-IDX" >dbi_result_get_double_idx</A ></DT ><DT >4.9.13. <A HREF="reference-field-idx.html#DBI-RESULT-GET-STRING-IDX" >dbi_result_get_string_idx</A ></DT ><DT >4.9.14. <A HREF="reference-field-idx.html#DBI-RESULT-GET-STRING-COPY-IDX" >dbi_result_get_string_copy_idx</A ></DT ><DT >4.9.15. <A HREF="reference-field-idx.html#DBI-RESULT-GET-BINARY-IDX" >dbi_result_get_binary_idx</A ></DT ><DT >4.9.16. <A HREF="reference-field-idx.html#DBI-RESULT-GET-BINARY-COPY-IDX" >dbi_result_get_binary_copy_idx</A ></DT ><DT >4.9.17. <A HREF="reference-field-idx.html#DBI-RESULT-GET-DATETIME-IDX" >dbi_result_get_datetime_idx</A ></DT ></DL ></DD ></DL ></DIV ></DIV ><DIV CLASS="NAVFOOTER" ><HR ALIGN="LEFT" WIDTH="100%"><TABLE SUMMARY="Footer navigation table" WIDTH="100%" BORDER="0" CELLPADDING="0" CELLSPACING="0" ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" ><A HREF="errornumbers.html" ACCESSKEY="P" >Prev</A ></TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" ><A HREF="index.html" ACCESSKEY="H" >Home</A ></TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" ><A HREF="reference-core.html" ACCESSKEY="N" >Next</A ></TD ></TR ><TR ><TD WIDTH="33%" ALIGN="left" VALIGN="top" >Error numbers</TD ><TD WIDTH="34%" ALIGN="center" VALIGN="top" > </TD ><TD WIDTH="33%" ALIGN="right" VALIGN="top" >Core Library Functions</TD ></TR ></TABLE ></DIV ></BODY ></HTML >