- 24.2.3 C API Function Descriptions
- 24.2.3.1 mysql_affected_rows()
- 24.2.3.2 mysql_autocommit()
- 24.2.3.3 mysql_change_user()
- 24.2.3.4 mysql_character_set_name()
- 24.2.3.5 mysql_close()
- 24.2.3.6 mysql_commit()
- 24.2.3.7 mysql_connect()
- 24.2.3.8 mysql_create_db()
- 24.2.3.9 mysql_data_seek()
- 24.2.3.10 mysql_debug()
- 24.2.3.11 mysql_drop_db()
- 24.2.3.12 mysql_dump_debug_info()
- 24.2.3.13 mysql_eof()
- 24.2.3.14 mysql_errno()
- 24.2.3.15 mysql_error()
- 24.2.3.16 mysql_escape_string()
- 24.2.3.17 mysql_fetch_field()
- 24.2.3.18 mysql_fetch_field_direct()
- 24.2.3.19 mysql_fetch_fields()
- 24.2.3.20 mysql_fetch_lengths()
- 24.2.3.21 mysql_fetch_row()
- 24.2.3.22 mysql_field_count()
- 24.2.3.23 mysql_field_seek()
- 24.2.3.24 mysql_field_tell()
- 24.2.3.25 mysql_free_result()
- 24.2.3.26 mysql_get_character_set_info()
- 24.2.3.27 mysql_get_client_info()
- 24.2.3.28 mysql_get_client_version()
- 24.2.3.29 mysql_get_host_info()
- 24.2.3.30 mysql_get_proto_info()
- 24.2.3.31 mysql_get_server_info()
- 24.2.3.32 mysql_get_server_version()
- 24.2.3.33 mysql_get_ssl_cipher()
- 24.2.3.34 mysql_hex_string()
- 24.2.3.35 mysql_info()
- 24.2.3.36 mysql_init()
- 24.2.3.37 mysql_insert_id()
- 24.2.3.38 mysql_kill()
- 24.2.3.39 mysql_library_end()
- 24.2.3.40 mysql_library_init()
- 24.2.3.41 mysql_list_dbs()
- 24.2.3.42 mysql_list_fields()
- 24.2.3.43 mysql_list_processes()
- 24.2.3.44 mysql_list_tables()
- 24.2.3.45 mysql_more_results()
- 24.2.3.46 mysql_next_result()
- 24.2.3.47 mysql_num_fields()
- 24.2.3.48 mysql_num_rows()
- 24.2.3.49 mysql_options()
- 24.2.3.50 mysql_ping()
- 24.2.3.51 mysql_query()
- 24.2.3.52 mysql_real_connect()
- 24.2.3.53 mysql_real_escape_string()
- 24.2.3.54 mysql_real_query()
- 24.2.3.55 mysql_refresh()
- 24.2.3.56 mysql_reload()
- 24.2.3.57 mysql_rollback()
- 24.2.3.58 mysql_row_seek()
- 24.2.3.59 mysql_row_tell()
- 24.2.3.60 mysql_select_db()
- 24.2.3.61 mysql_set_character_set()
- 24.2.3.62 mysql_set_local_infile_default()
- 24.2.3.63 mysql_set_local_infile_handler()
- 24.2.3.64 mysql_set_server_option()
- 24.2.3.65 mysql_shutdown()
- 24.2.3.66 mysql_sqlstate()
- 24.2.3.67 mysql_ssl_set()
- 24.2.3.68 mysql_stat()
- 24.2.3.69 mysql_store_result()
- 24.2.3.70 mysql_thread_id()
- 24.2.3.71 mysql_use_result()
- 24.2.3.72 mysql_warning_count()
MYSQL_RES *mysql_list_fields(MYSQL *mysql, const char
*table, const char *wild)
Description
Returns a result set consisting of field names in the given
table that match the simple regular expression specified by the
wild parameter. wild may
contain the wildcard characters
‘%’ or
‘_’, or may be a
NULL pointer to match all fields. Calling
mysql_list_fields() is similar to executing
the query SHOW COLUMNS FROM
.
tbl_name [LIKE
wild]
Note that it's recommended that you use SHOW COLUMNS
FROM instead of
tbl_namemysql_list_fields().
You must free the result set with
mysql_free_result().
Return Values
A MYSQL_RES result set for success.
NULL if an error occurred.
Errors
-
CR_COMMANDS_OUT_OF_SYNCCommands were executed in an improper order.
-
CR_SERVER_GONE_ERRORThe MySQL server has gone away.
-
CR_SERVER_LOSTThe connection to the server was lost during the query.
-
CR_UNKNOWN_ERRORAn unknown error occurred.
User Comments
While I understand the theory of why it's suggested to us "SHOW COLUMNS" over mysql_list_fields, I wouldn't suggest it. The "SHOW COLUMNS" leaves with a result set that you have to parse and interpret, while mysql_list_fields will give you access to the MYSQL_FIELD structures (which of course then lend to all of the flag comparisons as well as definition types).
I think you should use mysql_fetch_fields() and mysql_num_fields() with this. mysql_fetch_row() does not work with this API.
plz use mysql_fetch_fields() and mysql_num_fields() with this API. do not use mysql_fetch_row(). It does not work.
mysql_list_field is nothing but "SELECT * FROM Tablename" command. But it is not a "SELECT". "SELECT" will cause SQL to list the table out according to what you want to view. But "mysql_list_field" will not do that, but what it will do is to point the pointer to a particular "DATABASE" and "TABLE".
Once the pointer is there, then you can use "mysql_field_name" to get all the name of the field from the selected table.
If you use "SELECT" command and then use the "mysql_field_name", you can still get the name of the field, but different is "SELECT" will cause some time to execute as "mysql_list_field" is only to point a pointer to the particular table. That's why it's fast.
Add your own comment.