8.4.3 Описание функций интерфейса C

В приведенных здесь описаниях параметр или возвращаемая величина, обозначенная как NULL, означает NULL в терминах языка программирования C, а не величину NULL в MySQL.

Функции, возвращающие величину, обычно возвращают указатель или целое число. Если не указано иначе, то функции, возвращающие указатель, возвращают величину не-NULL при успешном выполнении или величину NULL, указывающую на ошибку, а функции, возвращающие целое число, возвращают нуль при успешном выполнении или ненулевую величину при возникновении ошибки. Следует учитывать, что термин ``ненулевая величина'' означает именно это. Если в описании функции не сказано иначе, то не следует пробовать интерпретировать эту величину иначе, чем нуль:

if (result)		 /* правильно */
   ... error ...
if (result < 0)		 /* неправильно */
   ... error ...
if (result == -1)	 /* неправильно */
   ... error ...

Если функция возвращает ошибку, то возможные типы ошибок представлены в ее описании в подраздел Ошибки. Вызвав функцию mysql_errno(), можно узнать, какие именно ошибки произошли. Строковое представление ошибки можно получить, вызывая функцию mysql_error().

Главы

• 8.4.3.1 mysql_affected_rows()
• 8.4.3.6 mysql_change_user()
• 8.4.3.11 mysql_character_set_name()
• 8.4.3.15 mysql_close()
• 8.4.3.19 mysql_connect()
• 8.4.3.23 mysql_create_db()
• 8.4.3.28 mysql_data_seek()
• 8.4.3.32 mysql_debug()
• 8.4.3.37 mysql_drop_db()
• 8.4.3.42 mysql_dump_debug_info()
• 8.4.3.46 mysql_eof()
• 8.4.3.51 mysql_errno()
• 8.4.3.55 mysql_error()
• 8.4.3.59 mysql_escape_string()
• 8.4.3.60 mysql_fetch_field()
• 8.4.3.65 mysql_fetch_field_direct()
• 8.4.3.70 mysql_fetch_fields()
• 8.4.3.75 mysql_fetch_lengths()
• 8.4.3.80 mysql_fetch_row()
• 8.4.3.85 mysql_field_count()
• 8.4.3.90 mysql_field_seek()
• 8.4.3.94 mysql_field_tell()
• 8.4.3.98 mysql_free_result()
• 8.4.3.102 mysql_get_client_info()
• 8.4.3.106 mysql_get_host_info()
• 8.4.3.110 mysql_get_proto_info()
• 8.4.3.114 mysql_get_server_info()
• 8.4.3.118 mysql_info()
• 8.4.3.122 mysql_init()
• 8.4.3.126 mysql_insert_id()
• 8.4.3.130 mysql_kill()
• 8.4.3.134 mysql_list_dbs()
• 8.4.3.138 mysql_list_fields()
• 8.4.3.142 mysql_list_processes()
• 8.4.3.146 mysql_list_tables()
• 8.4.3.150 mysql_num_fields()
• 8.4.3.155 mysql_num_rows()
• 8.4.3.159 mysql_options()
• 8.4.3.163 mysql_ping()
• 8.4.3.167 mysql_query()
• 8.4.3.171 mysql_real_connect()
• 8.4.3.176 mysql_real_escape_string()
• 8.4.3.181 mysql_real_query()
• 8.4.3.185 mysql_reload()
• 8.4.3.189 mysql_row_seek()
• 8.4.3.193 mysql_row_tell()
• 8.4.3.197 mysql_select_db()
• 8.4.3.201 mysql_shutdown()
• 8.4.3.205 mysql_stat()
• 8.4.3.209 mysql_store_result()
• 8.4.3.213 mysql_thread_id()
• 8.4.3.217 mysql_use_result()

User Comments

Why do you not use the 'doxygen' C Documentation tool. That's the best tool for documentation output of C/C++ APIs what i've seen.

Add your own comment.