9.1.3 C API 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 non-zero to indicate an error. Note that ``non-zero'' 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().

Subsections

• 9.1.3.1 mysql_affected_rows()
• 9.1.3.2 mysql_change_user()
• 9.1.3.3 mysql_character_set_name()
• 9.1.3.4 mysql_close()
• 9.1.3.5 mysql_connect()
• 9.1.3.6 mysql_create_db()
• 9.1.3.7 mysql_data_seek()
• 9.1.3.8 mysql_debug()
• 9.1.3.9 mysql_drop_db()
• 9.1.3.10 mysql_dump_debug_info()
• 9.1.3.11 mysql_eof()
• 9.1.3.12 mysql_errno()
• 9.1.3.13 mysql_error()
• 9.1.3.14 mysql_escape_string()
• 9.1.3.15 mysql_fetch_field()
• 9.1.3.16 mysql_fetch_fields()
• 9.1.3.17 mysql_fetch_field_direct()
• 9.1.3.18 mysql_fetch_lengths()
• 9.1.3.19 mysql_fetch_row()
• 9.1.3.20 mysql_field_count()
• 9.1.3.21 mysql_field_seek()
• 9.1.3.22 mysql_field_tell()
• 9.1.3.23 mysql_free_result()
• 9.1.3.24 mysql_get_client_info()
• 9.1.3.25 mysql_get_server_version()
• 9.1.3.26 mysql_get_host_info()
• 9.1.3.27 mysql_get_proto_info()
• 9.1.3.28 mysql_get_server_info()
• 9.1.3.29 mysql_info()
• 9.1.3.30 mysql_init()
• 9.1.3.31 mysql_insert_id()
• 9.1.3.32 mysql_kill()
• 9.1.3.33 mysql_list_dbs()
• 9.1.3.34 mysql_list_fields()
• 9.1.3.35 mysql_list_processes()
• 9.1.3.36 mysql_list_tables()
• 9.1.3.37 mysql_num_fields()
• 9.1.3.38 mysql_num_rows()
• 9.1.3.39 mysql_options()
• 9.1.3.40 mysql_ping()
• 9.1.3.41 mysql_query()
• 9.1.3.42 mysql_real_connect()
• 9.1.3.43 mysql_real_escape_string()
• 9.1.3.44 mysql_real_query()
• 9.1.3.45 mysql_reload()
• 9.1.3.46 mysql_row_seek()
• 9.1.3.47 mysql_row_tell()
• 9.1.3.48 mysql_select_db()
• 9.1.3.49 mysql_sqlstate()
• 9.1.3.50 mysql_shutdown()
• 9.1.3.51 mysql_stat()
• 9.1.3.52 mysql_store_result()
• 9.1.3.53 mysql_thread_id()
• 9.1.3.54 mysql_use_result()
• 9.1.3.55 mysql_commit()
• 9.1.3.56 mysql_rollback()
• 9.1.3.57 mysql_autocommit()
• 9.1.3.58 mysql_more_results()
• 9.1.3.59 mysql_next_result()

User Comments

Add your own comment.