Documentation Home
MySQL 5.5 Reference Manual
Related Documentation Download this Manual
PDF (US Ltr) - 27.1Mb
PDF (A4) - 27.2Mb
PDF (RPM) - 25.6Mb
HTML Download (TGZ) - 6.4Mb
HTML Download (Zip) - 6.5Mb
HTML Download (RPM) - 5.5Mb
Man Pages (TGZ) - 159.1Kb
Man Pages (Zip) - 262.6Kb
Info (Gzip) - 2.6Mb
Info (Zip) - 2.6Mb
Excerpts from this Manual

MySQL 5.5 Reference Manual  /  ...  /  C API Function Descriptions

23.8.7 C API Function Descriptions

[+/-]

23.8.7.1 mysql_affected_rows()
23.8.7.2 mysql_autocommit()
23.8.7.3 mysql_change_user()
23.8.7.4 mysql_character_set_name()
23.8.7.5 mysql_close()
23.8.7.6 mysql_commit()
23.8.7.7 mysql_connect()
23.8.7.8 mysql_create_db()
23.8.7.9 mysql_data_seek()
23.8.7.10 mysql_debug()
23.8.7.11 mysql_drop_db()
23.8.7.12 mysql_dump_debug_info()
23.8.7.13 mysql_eof()
23.8.7.14 mysql_errno()
23.8.7.15 mysql_error()
23.8.7.16 mysql_escape_string()
23.8.7.17 mysql_fetch_field()
23.8.7.18 mysql_fetch_field_direct()
23.8.7.19 mysql_fetch_fields()
23.8.7.20 mysql_fetch_lengths()
23.8.7.21 mysql_fetch_row()
23.8.7.22 mysql_field_count()
23.8.7.23 mysql_field_seek()
23.8.7.24 mysql_field_tell()
23.8.7.25 mysql_free_result()
23.8.7.26 mysql_get_character_set_info()
23.8.7.27 mysql_get_client_info()
23.8.7.28 mysql_get_client_version()
23.8.7.29 mysql_get_host_info()
23.8.7.30 mysql_get_proto_info()
23.8.7.31 mysql_get_server_info()
23.8.7.32 mysql_get_server_version()
23.8.7.33 mysql_get_ssl_cipher()
23.8.7.34 mysql_hex_string()
23.8.7.35 mysql_info()
23.8.7.36 mysql_init()
23.8.7.37 mysql_insert_id()
23.8.7.38 mysql_kill()
23.8.7.39 mysql_library_end()
23.8.7.40 mysql_library_init()
23.8.7.41 mysql_list_dbs()
23.8.7.42 mysql_list_fields()
23.8.7.43 mysql_list_processes()
23.8.7.44 mysql_list_tables()
23.8.7.45 mysql_more_results()
23.8.7.46 mysql_next_result()
23.8.7.47 mysql_num_fields()
23.8.7.48 mysql_num_rows()
23.8.7.49 mysql_options()
23.8.7.50 mysql_ping()
23.8.7.51 mysql_query()
23.8.7.52 mysql_real_connect()
23.8.7.53 mysql_real_escape_string()
23.8.7.54 mysql_real_query()
23.8.7.55 mysql_refresh()
23.8.7.56 mysql_reload()
23.8.7.57 mysql_rollback()
23.8.7.58 mysql_row_seek()
23.8.7.59 mysql_row_tell()
23.8.7.60 mysql_select_db()
23.8.7.61 mysql_set_character_set()
23.8.7.62 mysql_set_local_infile_default()
23.8.7.63 mysql_set_local_infile_handler()
23.8.7.64 mysql_set_server_option()
23.8.7.65 mysql_shutdown()
23.8.7.66 mysql_sqlstate()
23.8.7.67 mysql_ssl_set()
23.8.7.68 mysql_stat()
23.8.7.69 mysql_store_result()
23.8.7.70 mysql_thread_id()
23.8.7.71 mysql_use_result()
23.8.7.72 mysql_warning_count()

This section describes C API functions other than those used for prepared statements or the replication stream interface. For information about those, see Section 23.8.11, “C API Prepared Statement Function Descriptions”, and C API Binary Log Function Descriptions.

In the descriptions here, a parameter or return value of NULL means NULL in the sense of the C programming language, not a MySQL NULL value.

Functions that return a value generally return a pointer or an integer. Unless specified otherwise, functions returning a pointer return a non-NULL value to indicate success or a NULL value to indicate an error, and functions returning an integer return zero to indicate success or nonzero to indicate an error. Note that nonzero means just that. Unless the function description says otherwise, do not test against a value other than zero:

if (result)                   /* correct */
    ... error ...

if (result < 0)               /* incorrect */
    ... error ...

if (result == -1)             /* incorrect */
    ... error ...

When a function returns an error, the Errors subsection of the function description lists the possible types of errors. You can find out which of these occurred by calling mysql_errno(). A string representation of the error may be obtained by calling mysql_error().