├── README.md └── webhelp ├── Makefile ├── build.properties ├── build.xml ├── docsrc ├── CMakeLists.txt ├── api │ ├── change_global.php │ ├── charset │ │ ├── book.xml │ │ ├── charsets.xml │ │ ├── data_structures.xml │ │ ├── entities.functions.xml │ │ ├── mariadb_convert_string.xml │ │ ├── mysql_get_character_set_info.xml │ │ ├── mysql_get_charset_by_name.xml │ │ ├── mysql_get_charset_by_nr.xml │ │ ├── mysql_set_character_set.xml │ │ └── reference.xml │ ├── client_server │ │ ├── book.xml │ │ ├── constants.xml │ │ ├── data_structures.xml │ │ ├── entities.functions.xml │ │ ├── mysql_affected_rows.xml │ │ ├── mysql_autocommit.xml │ │ ├── mysql_change_user.xml │ │ ├── mysql_character_set_name.xml │ │ ├── mysql_close.xml │ │ ├── mysql_commit.xml │ │ ├── mysql_data_seek.xml │ │ ├── mysql_debug.xml │ │ ├── mysql_debug_end.xml │ │ ├── mysql_dump_debug_info.xml │ │ ├── mysql_errno.xml │ │ ├── mysql_error.xml │ │ ├── mysql_escape_string.xml │ │ ├── mysql_fetch_field.xml │ │ ├── mysql_fetch_field_direct.xml │ │ ├── mysql_fetch_fields.xml │ │ ├── mysql_fetch_lengths.xml │ │ ├── mysql_fetch_row.xml │ │ ├── mysql_field_count.xml │ │ ├── mysql_field_seek.xml │ │ ├── mysql_field_tell.xml │ │ ├── mysql_free_result.xml │ │ ├── mysql_get_client_info.xml │ │ ├── mysql_get_client_version.xml │ │ ├── mysql_get_host_info.xml │ │ ├── mysql_get_proto_info.xml │ │ ├── mysql_get_server_info.xml │ │ ├── mysql_get_server_version.xml │ │ ├── mysql_get_ssl_cipher.xml │ │ ├── mysql_hex_string.xml │ │ ├── mysql_info.xml │ │ ├── mysql_init.xml │ │ ├── mysql_insert_id.xml │ │ ├── mysql_kill.xml │ │ ├── mysql_library_end.xml │ │ ├── mysql_library_init.xml │ │ ├── mysql_more_results.xml │ │ ├── mysql_next_result.xml │ │ ├── mysql_num_fields.xml │ │ ├── mysql_num_rows.xml │ │ ├── mysql_options.xml │ │ ├── mysql_options4.xml │ │ ├── mysql_optionsv.xml │ │ ├── mysql_ping.xml │ │ ├── mysql_query.xml │ │ ├── mysql_read_query_result.xml │ │ ├── mysql_real_connect.xml │ │ ├── mysql_real_escape_string.xml │ │ ├── mysql_real_query.xml │ │ ├── mysql_refresh.xml │ │ ├── mysql_reload.xml │ │ ├── mysql_rollback.xml │ │ ├── mysql_row_seek.xml │ │ ├── mysql_row_tell.xml │ │ ├── mysql_select_db.xml │ │ ├── mysql_send_query.xml │ │ ├── mysql_server_end.xml │ │ ├── mysql_server_init.xml │ │ ├── mysql_set_server_option.xml │ │ ├── mysql_shutdown.xml │ │ ├── mysql_sqlstate.xml │ │ ├── mysql_ssl_set.xml │ │ ├── mysql_stat.xml │ │ ├── mysql_stmt_affected_rows.xml │ │ ├── mysql_stmt_attr_get.xml │ │ ├── mysql_stmt_attr_set.xml │ │ ├── mysql_stmt_bind_param.xml │ │ ├── mysql_stmt_bind_result.xml │ │ ├── mysql_stmt_close.xml │ │ ├── mysql_stmt_data_seek.xml │ │ ├── mysql_stmt_errno.xml │ │ ├── mysql_stmt_error.xml │ │ ├── mysql_stmt_execute.xml │ │ ├── mysql_stmt_fetch.xml │ │ ├── mysql_stmt_fetch_column.xml │ │ ├── mysql_stmt_field_count.xml │ │ ├── mysql_stmt_free_result.xml │ │ ├── mysql_stmt_init.xml │ │ ├── mysql_stmt_insert_id.xml │ │ ├── mysql_stmt_more_results.xml │ │ ├── mysql_stmt_next_result.xml │ │ ├── mysql_stmt_num_rows.xml │ │ ├── mysql_stmt_param_count.xml │ │ ├── mysql_stmt_param_metadata.xml │ │ ├── mysql_stmt_prepare.xml │ │ ├── mysql_stmt_reset.xml │ │ ├── mysql_stmt_result_metadata.xml │ │ ├── mysql_stmt_row_seek.xml │ │ ├── mysql_stmt_row_tell.xml │ │ ├── mysql_stmt_send_long_data.xml │ │ ├── mysql_stmt_sqlstate.xml │ │ ├── mysql_stmt_store_result.xml │ │ ├── mysql_store_result.xml │ │ ├── mysql_thread_end.xml │ │ ├── mysql_thread_id.xml │ │ ├── mysql_thread_init.xml │ │ ├── mysql_thread_safe.xml │ │ ├── mysql_use_result.xml │ │ ├── mysql_warning_count.xml │ │ └── reference.xml │ ├── dyncol │ │ ├── book.xml │ │ ├── constants.xml │ │ ├── data_structures.xml │ │ ├── entities.functions.xml │ │ ├── mariadb_dyncol_column_count.xml │ │ ├── mariadb_dyncol_create_many_named.xml │ │ ├── mariadb_dyncol_create_many_num.xml │ │ ├── mariadb_dyncol_exists_named.xml │ │ ├── mariadb_dyncol_exists_num.xml │ │ ├── mariadb_dyncol_free.xml │ │ ├── mariadb_dyncol_get_named.xml │ │ ├── mariadb_dyncol_get_num.xml │ │ ├── mariadb_dyncol_init.xml │ │ ├── mariadb_dyncol_list_named.xml │ │ ├── mariadb_dyncol_list_num.xml │ │ ├── mariadb_dyncol_unpack.xml │ │ ├── mariadb_dyncol_update_many_named.xml │ │ ├── mariadb_dyncol_update_many_num.xml │ │ └── reference.xml │ ├── nonblock │ │ ├── book.xml │ │ ├── entities.functions.xml │ │ ├── mysql_get_socket.xml │ │ ├── mysql_get_timeout_value.xml │ │ ├── mysql_get_timeout_value_ms.xml │ │ ├── mysql_real_connect_cont.xml │ │ ├── mysql_real_connect_start.xml │ │ ├── mysql_real_query_cont.xml │ │ ├── mysql_real_query_start.xml │ │ ├── reference.xml │ │ ├── tags │ │ └── usage.xml │ └── x.x ├── appendices │ ├── changelog.xml │ ├── license.xml │ └── quanda.xml ├── bookinfo.xml ├── chapters │ ├── installation.xml │ └── introduction.xml ├── entities │ ├── default-defs.ent │ ├── file.ent.in │ ├── funcref.ent.in │ ├── functions.ent.in │ └── var.ent.in ├── examples │ ├── CMakeLists.txt │ ├── mariadb_dyncol_list_named.c │ ├── mariadb_dyncol_list_num.c │ ├── mysql_affected_rows.c │ ├── mysql_autocommit.c │ ├── mysql_change_user.c │ ├── mysql_character_set_name.c │ ├── mysql_commit.c │ ├── mysql_data_seek.c │ ├── mysql_debug.c │ ├── mysql_errno.c │ ├── mysql_error.c │ ├── mysql_real_connect_start.c │ └── nonblock_1.c ├── global.ent ├── images │ ├── v_1_0.png │ ├── v_1_1.png │ └── v_2_0..png ├── main.docbook ├── preface.xml ├── revhistory │ ├── log.xml │ └── log.xml.in ├── scripts │ └── add_funcref.php ├── url.ent └── xsl │ ├── bzr.xsl │ └── mariadb.xsl ├── template ├── common │ ├── browserDetect.js │ ├── css │ │ ├── ie.css │ │ └── positioning.css │ ├── images │ │ ├── callouts │ │ │ ├── 1.png │ │ │ ├── 10.png │ │ │ ├── 11.png │ │ │ ├── 12.png │ │ │ ├── 13.png │ │ │ ├── 14.png │ │ │ ├── 15.png │ │ │ ├── 16.png │ │ │ ├── 17.png │ │ │ ├── 18.png │ │ │ ├── 19.png │ │ │ ├── 2.png │ │ │ ├── 20.png │ │ │ ├── 21.png │ │ │ ├── 22.png │ │ │ ├── 23.png │ │ │ ├── 24.png │ │ │ ├── 25.png │ │ │ ├── 26.png │ │ │ ├── 27.png │ │ │ ├── 28.png │ │ │ ├── 29.png │ │ │ ├── 3.png │ │ │ ├── 30.png │ │ │ ├── 4.png │ │ │ ├── 5.png │ │ │ ├── 6.png │ │ │ ├── 7.png │ │ │ ├── 8.png │ │ │ └── 9.png │ │ ├── header-bg.gif │ │ ├── header-bg.png │ │ ├── highlight-blue.gif │ │ ├── highlight-yellow.gif │ │ ├── logo.png │ │ ├── next-arrow.png │ │ ├── note.png │ │ ├── previous-arrow.png │ │ ├── search-icon.png │ │ ├── showHideTreeIcons.png │ │ ├── sidebar.png │ │ ├── starsSmall.png │ │ └── toc-icon.png │ ├── jquery │ │ ├── jquery-1.7.2.min.js │ │ ├── jquery-ui-1.8.2.custom.min.js │ │ ├── jquery.cookie.js │ │ ├── jquery.ui.all.js │ │ ├── layout │ │ │ └── jquery.layout.js │ │ ├── theme-redmond │ │ │ ├── images │ │ │ │ ├── ui-anim_basic_16x16.gif │ │ │ │ ├── ui-bg_flat_0_aaaaaa_40x100.png │ │ │ │ ├── ui-bg_flat_55_fbec88_40x100.png │ │ │ │ ├── ui-bg_glass_75_d0e5f5_1x400.png │ │ │ │ ├── ui-bg_glass_85_dfeffc_1x400.png │ │ │ │ ├── ui-bg_glass_95_fef1ec_1x400.png │ │ │ │ ├── ui-bg_gloss-wave_55_5c9ccc_500x100.png │ │ │ │ ├── ui-bg_inset-hard_100_f5f8f9_1x100.png │ │ │ │ ├── ui-bg_inset-hard_100_fcfdfd_1x100.png │ │ │ │ ├── ui-icons_217bc0_256x240.png │ │ │ │ ├── ui-icons_2e83ff_256x240.png │ │ │ │ ├── ui-icons_469bdd_256x240.png │ │ │ │ ├── ui-icons_6da8d5_256x240.png │ │ │ │ ├── ui-icons_cd0a0a_256x240.png │ │ │ │ ├── ui-icons_d8e7f3_256x240.png │ │ │ │ └── ui-icons_f9bd01_256x240.png │ │ │ ├── jquery-ui-1.8.2.custom.css │ │ │ └── jquery-ui-1.8.21.custom.css │ │ └── treeview │ │ │ ├── images │ │ │ ├── file.gif │ │ │ ├── folder-closed2.gif │ │ │ ├── folder.gif │ │ │ ├── folder2.gif │ │ │ ├── minus.gif │ │ │ ├── plus.gif │ │ │ ├── treeview-black-line.gif │ │ │ ├── treeview-black.gif │ │ │ ├── treeview-default-line.gif │ │ │ ├── treeview-default.gif │ │ │ ├── treeview-famfamfam-line.gif │ │ │ ├── treeview-famfamfam.gif │ │ │ ├── treeview-gray-line.gif │ │ │ ├── treeview-gray.gif │ │ │ ├── treeview-red-line.gif │ │ │ └── treeview-red.gif │ │ │ ├── jquery.treeview.css │ │ │ └── jquery.treeview.min.js │ ├── main.js │ └── splitterInit.js ├── favicon.ico └── search │ ├── default.props │ ├── en-us.props │ ├── es-es.props │ ├── ja-jp.props │ ├── nwSearchFnt.js │ ├── punctuation.props │ └── stemmers │ ├── de_stemmer.js │ ├── en_stemmer.js │ └── fr_stemmer.js ├── xincluded-profiled.xml └── xsl ├── titlepage.templates.xml ├── titlepage.templates.xsl ├── webhelp-common.xsl └── webhelp.xsl /README.md: -------------------------------------------------------------------------------- 1 | connector-c-docs 2 | ================ 3 | 4 | MariaDB Connector/C Documentation 5 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/charset/book.xml: -------------------------------------------------------------------------------- 1 | 2 |
3 | 4 | Character set API 5 | 6 | 7 | &product_name; supports various character sets and client side 8 | character set conversion. 9 | 10 | 11 | Due to license restrictions &product_name; doesn't use the character 12 | set routines and functionality from the server. Instead it uses the iconv 13 | library and on Windows platforms native Windows API functions. This might lead 14 | to different results, since server routines don't support all panes of 15 | specific character sets. 16 | 17 | &reftitle.notes; 18 | 19 | &reftitle.notes; 20 | 21 | Character set support was added in Version 1.1 22 | 23 | 24 | The default character set is utf8. 25 | 26 | 27 | &api.charset.charsets; 28 | &api.charset.data_structures; 29 | &api.charset.reference; 30 |
31 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/charset/entities.functions.xml: -------------------------------------------------------------------------------- 1 | 4 | &api.charset.mariadb_convert_string; 5 | &api.charset.mysql_get_character_set_info; 6 | &api.charset.mysql_get_charset_by_name; 7 | &api.charset.mysql_get_charset_by_nr; 8 | &api.charset.mysql_set_character_set; 9 | 10 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/charset/mysql_get_character_set_info.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_get_character_set_info 5 | 6 | 7 | mysql_get_character_set_info 8 | Returns information about the current active character set. 9 | 10 | 11 | &reftitle.description; 12 | 13 | void 14 | mysql_get_character_set_info 15 | 16 | MYSQL * 17 | mysql 18 | 19 | 20 | MY_CHARSET_INFO * 21 | charset 22 | 23 | 24 | 25 | Returns information about the current default character set for the specified 26 | connection. 27 | 28 | 29 | 30 | &reftitle.parameters; 31 | 32 | 33 | 34 | mysql 35 | ¶m.mysql; 36 | 37 | 38 | charset 39 | A pointer to a MY_CHARSET_INFO structure, in which the information will be copied. 40 | 41 | 42 | 43 | 44 | 45 | &reftitle.retval; 46 | 47 | void 48 | 49 | 50 | 51 | &reftitle.notes; 52 | 53 | 54 | A complete list of supported character sets in &product_name; is listed 55 | in the function description for &function.mysql_set_character_set;. 56 | 57 | 58 | 59 | 60 | &reftitle.seealso; 61 | 62 | &function.mysql_set_character_set; 63 | 64 | 65 | 66 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/charset/mysql_get_charset_by_name.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_get_charset_by_name 5 | 6 | 7 | mysql_get_charset_by_name 8 | Returns a specified character set 9 | 10 | 11 | &reftitle.description; 12 | 13 | CHARSET_INFO * 14 | mysql_get_charset_by_name 15 | 16 | const char * 17 | csname 18 | 19 | 20 | 21 | returns a character set specified by 22 | csname 23 | . 24 | 25 | 26 | 27 | &reftitle.parameters; 28 | 29 | 30 | 31 | csname 32 | Character set name 33 | 34 | 35 | 36 | 37 | 38 | &reftitle.retval; 39 | 40 | Returns a pointer to 41 | CHARSET_INFO 42 | or NULL if the specified character set could not be found. 43 | 44 | 45 | 46 | &reftitle.notes; 47 | 48 | &reftitle.notes; 49 | 50 | The function searches case sensitive. Character set names are always defined 51 | in lower case. 52 | 53 | 54 | 55 | 56 | &reftitle.seealso; 57 | 58 | &function.mysql_get_charset_by_nr; 59 | 60 | 61 | 62 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/charset/mysql_get_charset_by_nr.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_get_charset_by_nr 5 | 6 | 7 | mysql_get_charset_by_nr 8 | Returns a specified character set 9 | 10 | 11 | &reftitle.description; 12 | 13 | CHARSET_INFO * 14 | mysql_get_charset_by_name 15 | 16 | uint 17 | number 18 | 19 | 20 | 21 | returns a character set specified by 22 | number 23 | . 24 | 25 | 26 | 27 | &reftitle.parameters; 28 | 29 | 30 | 31 | number 32 | Character set number 33 | 34 | 35 | 36 | 37 | 38 | &reftitle.retval; 39 | 40 | A 41 | CHARSET_INFO 42 | pointer of NULL if the specified character set could not be found. 43 | 44 | 45 | 46 | &reftitle.notes; 47 | 48 | &reftitle.notes; 49 | 50 | Character set numbers are specified in source file 51 | my_charset.c 52 | . 53 | 54 | 55 | The same character set might have different numbers, since internally 56 | numbers also specify the collation. E.g the character set 57 | latin1 58 | has the numbers 47, 48, 49 and 94. &product_name; itself doesn't support 59 | collations. 60 | 61 | 62 | 63 | 64 | &reftitle.seealso; 65 | 66 | &function.mysql_get_charset_by_name; 67 | 68 | 69 | 70 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/charset/reference.xml: -------------------------------------------------------------------------------- 1 | 2 |
3 | 4 | 5 | Function reference 6 | 7 | &api.charset.entities.functions; 8 |
9 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/book.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |
5 | 6 | Client server API 7 | 8 | 9 | The client server API of &product_name; allows you to send and 10 | retrieve data to and from a MariaDB database server. It supports also 11 | communication with databases from other vendors, like Percona or Oracle. 12 | 13 | 14 | Several other client APIs, like MariaDB Connector/ODBC use &product_name; 15 | to communicate with a MariaDB database server. 16 | 17 | 18 | &api.client_server.data_structures; 19 | &api.client_server.constants; 20 | &api.client_server.reference; 21 |
22 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_character_set_name.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_character_set_name 5 | 6 | 7 | mysql_character_set_name 8 | returns the name of the current client character set 9 | 10 | 11 | &reftitle.description; 12 | &reftitle.description; 13 | 14 | const char * 15 | mysql_character_set_name 16 | 17 | MYSQL * 18 | mysql 19 | 20 | 21 | 22 | Returns the name of the current client character set for the specified 23 | connection. 24 | 25 | 26 | 27 | &reftitle.parameters; 28 | 29 | 30 | 31 | mysql 32 | ¶m.mysql; 33 | 34 | 35 | 36 | 37 | 38 | &reftitle.retval; 39 | 40 | The default client character set for the specified connection 41 | 42 | 43 | 44 | &reftitle.notes; 45 | 46 | 47 | 48 | For a list of available character sets see 49 | supported character sets . 50 | 51 | 52 | 53 | 54 | 55 | &reftitle.seealso; 56 | 57 | &function.mysql_get_character_set_info;, &function.mysql_set_character_set; 58 | 59 | 60 | 61 | 62 | Example 63 | 64 | &examples.mysql_character_set_name; 65 | 66 | Output: 67 | 68 | 69 | 70 | 71 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_close.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_close 5 | 6 | 7 | mysql_close 8 | Closes a previously opened connection 9 | 10 | 11 | &reftitle.description; 12 | &reftitle.description; 13 | 14 | void 15 | mysql_close 16 | 17 | MYSQL * 18 | mysql 19 | 20 | 21 | 22 | Closes a previously opened connection. 23 | 24 | 25 | In case 26 | mysql 27 | was allocated by mysql_init, &function.mysql_close; will also free allocated 28 | memory and resources. 29 | 30 | 31 | 32 | &reftitle.parameters; 33 | 34 | 35 | 36 | mysql 37 | ¶m.mysql; 38 | 39 | 40 | 41 | 42 | 43 | &reftitle.retval; 44 | 45 | void. 46 | 47 | 48 | 49 | &reftitle.version; 50 | &product_name; 1.0 51 | 52 | 53 | &reftitle.notes; 54 | 55 | 56 | 57 | To avoid memory leaks and to save system ressources a connection handle 58 | should always be closed. 59 | 60 | 61 | 62 | 63 | 64 | &reftitle.seealso; 65 | 66 | &function.mysql_real_connect;, &function.mysql_init; 67 | 68 | 69 | 70 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_debug_end.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_debug_end 5 | 6 | 7 | mysql_debug_end 8 | Disables output of debug information 9 | 10 | 11 | &reftitle.description; 12 | &reftitle.description; 13 | 14 | void 15 | mysql_debug_end 16 | 17 | void 18 | 19 | 20 | 21 | Stops output of debug information. 22 | 23 | 24 | &reftitle.retval; 25 | 26 | void 27 | 28 | 29 | 30 | &reftitle.version; 31 | &product_name; 1.0 32 | 33 | 34 | &reftitle.notes; 35 | 36 | 37 | 38 | For using this function the mariadb-client library must be 39 | compiled with debug support 40 | 41 | 42 | 43 | 44 | 45 | &reftitle.seealso; 46 | 47 | &function.mysql_debug_end;, &function.mysql_dump_debug_info; 48 | 49 | 50 | 59 | 60 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_dump_debug_info.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_dump_debug_info 5 | 6 | 7 | mysql_dump_debug_info 8 | Dump server status information 9 | 10 | 11 | &reftitle.description; 12 | &reftitle.description; 13 | 14 | int 15 | mysql_dump_debug_info 16 | 17 | MYSQL * 18 | mysql 19 | 20 | 21 | 22 | This function is designed to be executed by an user with the SUPER privilege 23 | and is used to dump server status information into the log for the MariaDB 24 | Server relating to the connection. 25 | 26 | 27 | 28 | &reftitle.parameters; 29 | 30 | 31 | 32 | mysql 33 | 34 | ¶m.mysql; 35 | 36 | 37 | 38 | 39 | 40 | 41 | &reftitle.retval; 42 | 43 | &return.my_bool; 44 | 45 | 46 | 47 | &reftitle.version; 48 | &product_name; 1.0 49 | 50 | 51 | &reftitle.notes; 52 | 53 | 54 | The server status information will be dumped into the error log file, which 55 | can be found in the data directory of your server installation. 56 | 57 | 58 | 59 | 60 | &reftitle.seealso; 61 | 62 | &function.mysql_debug;, &function.mysql_debug_end; 63 | 64 | 65 | 66 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_errno.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_errno 5 | 6 | 7 | mysql_errno 8 | Returns the error code for the most recent function call 9 | 10 | 11 | &reftitle.description; 12 | &reftitle.description; 13 | 14 | unsigned int 15 | mysql_errno 16 | 17 | MYSQL * 18 | mysql 19 | 20 | 21 | 22 | Returns the last error code for the most recent function call that can 23 | succeed or fail. 24 | 25 | 26 | 27 | &reftitle.parameters; 28 | 29 | 30 | 31 | mysql 32 | 33 | ¶m.mysql; 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | &reftitle.retval; 42 | 43 | An error code value for the last call, if it failed. zero means no error 44 | occurred. 45 | 46 | 47 | 48 | &reftitle.version; 49 | &product_name; 1.0 50 | 51 | 52 | reftitle.notes; 53 | 54 | 55 | Client error messages are listed in 56 | errmsg.h 57 | header file, server error messages are listed in 58 | mysqld_error.h 59 | header file of the server source distribution. 60 | 61 | 62 | 63 | 64 | &reftitle.seealso; 65 | 66 | &function.mysql_error;, &function.mysql_sqlstate;. 67 | 68 | 69 | 70 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_error.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_error 5 | 6 | 7 | mysql_error 8 | Returns a string description of the last error 9 | 10 | 11 | &reftitle.description; 12 | &reftitle.description; 13 | 14 | const char * 15 | mysql_error 16 | 17 | MYSQL * 18 | mysql 19 | 20 | 21 | 22 | Returns the last error message for the most recent function call that can 23 | succeed or fail. 24 | 25 | 26 | 27 | &reftitle.parameters; 28 | 29 | 30 | 31 | mysql 32 | 33 | ¶m.mysql; 34 | 35 | 36 | 37 | 38 | 39 | 40 | &reftitle.retval; 41 | 42 | A string that describes the error. If no error occured an emtry string is 43 | returned. 44 | 45 | 46 | 47 | &reftitle.version; 48 | &product_name; 1.0 49 | 50 | 51 | reftitle.notes; 52 | 53 | 54 | Client error messages are listed in 55 | errmsg.c of &product_name; source distribution. 56 | 57 | 58 | 59 | 60 | 61 | &reftitle.seealso; 62 | 63 | &function.mysql_errno;, &function.mysql_sqlstate;. 64 | 65 | 66 | 67 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_escape_string.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_escape_string 5 | 6 | 7 | mysql_escape_string 8 | escapes a string using the default character set 9 | 10 | 11 | &reftitle.description; 12 | 13 | unsigned long 14 | mysql_escape_string 15 | 16 | char * 17 | to 18 | 19 | 20 | const char * 21 | from 22 | 23 | 24 | unsigned 25 | long 26 | 27 | 28 | 29 | 30 | 31 | &deprecated.function; 32 | 33 | 34 | Please use &function.mysql_real_escape_string; instead. 35 | 36 | 37 | 38 | &reftitle.seealso; 39 | 40 | &function.mysql_real_escape_string; 41 | 42 | 43 | 44 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_fetch_field_direct.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_fetch_field_direct 5 | 6 | 7 | mysql_fetch_field_direct 8 | Fetch meta data for a single field 9 | 10 | 11 | &reftitle.description; 12 | 13 | MYSQL_FIELD * 14 | mysql_fetch_field_direct 15 | 16 | MYSQL_RES * 17 | res 18 | 19 | 20 | unsigned int 21 | fieldnr 22 | 23 | 24 | 25 | Returns a pointer to a 26 | MYSQL_FIELD 27 | structure which contains field information from the specified result set. 28 | 29 | 30 | 31 | &reftitle.parameters; 32 | 33 | 34 | 35 | res 36 | ¶m.result; 37 | 38 | 39 | fieldnr 40 | The field number. This value must be within the range from 0 to number of fields - 1 41 | 42 | 43 | 44 | 45 | 46 | &reftitle.retval; 47 | 48 | A pointer to a 49 | MYSQL_FIELD 50 | structure 51 | 52 | 53 | 54 | &reftitle.version; 55 | 56 | &product_name; 1.0 57 | 58 | 59 | 60 | &reftitle.notes; 61 | 62 | 63 | The total number of fields can be obtained by &function.mysql_field_count; 64 | 65 | 66 | 67 | 68 | &reftitle.seealso; 69 | 70 | &function.mysql_fetch_field;, &function.mysql_field_count; 71 | 72 | 73 | 74 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_fetch_fields.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_fetch_fields 5 | 6 | 7 | mysql_fetch_fields 8 | Returns an array of fields representing the fields in a result set 9 | 10 | 11 | &reftitle.description; 12 | 13 | MYSQL_FIELD * 14 | mysql_fetch_fields 15 | 16 | MYSQL_RES * 17 | res 18 | 19 | 20 | 21 | This function serves an identical purpose to the &function.mysql_fetch_field; 22 | function with the single difference that instead of returning one field at a 23 | time for each field, the fields are returned as an array. Each field contains 24 | the definition for a column of the result set. 25 | 26 | 27 | 28 | &reftitle.parameters; 29 | 30 | 31 | 32 | res 33 | ¶m.result; 34 | 35 | 36 | 37 | 38 | 39 | &reftitle.retval; 40 | 41 | An array of fields. 42 | 43 | 44 | 45 | &reftitle.notes; 46 | 47 | 48 | The total number of fields can be obtained by &function.mysql_field_count; 49 | 50 | 51 | 52 | 53 | &reftitle.seealso; 54 | 55 | &function.mysql_fetch_field;, 56 | &function.mysql_fetch_field_direct;&function.mysql_field_count; 57 | 58 | 59 | 60 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_fetch_lengths.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_fetch_lengths 5 | 6 | 7 | mysql_fetch_lengths 8 | Returns the length of the columns of the current row 9 | 10 | 11 | &reftitle.description; 12 | 13 | unsigned long * 14 | mysql_fetch_lengths 15 | 16 | MYSQL_RES * 17 | result 18 | 19 | 20 | 21 | The &function.mysql_fetch_lengths; function returns an array containing the 22 | lengths of every column of the current row within the result set. 23 | 24 | 25 | 26 | &reftitle.parameters; 27 | 28 | 29 | 30 | result 31 | ¶m.result; 32 | 33 | 34 | 35 | 36 | 37 | &reftitle.retval; 38 | 39 | An array of unsigned long integers representing the size of each column (not 40 | including terminating zero character) or 41 | NULL 42 | if an error occured. 43 | 44 | 45 | 46 | &reftitle.notes; 47 | 48 | 49 | &function.mysql_fetch_lengths; is valid only for the current row of the 50 | result set. It returns NULL if you call it before calling 51 | &function.mysql_fetch_row; or after retrieving all rows in the result. 52 | 53 | 54 | 55 | 56 | &reftitle.seealso; 57 | 58 | &function.mysql_fetch_row; 59 | 60 | 61 | 62 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_field_count.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_field_count 5 | 6 | 7 | mysql_field_count 8 | Returns the number of fields for the most recent query 9 | 10 | 11 | &reftitle.description; 12 | 13 | unsigned int 14 | mysql_field_count 15 | 16 | MYSQL * 17 | mysql 18 | 19 | 20 | 21 | Returns the number of columns for the most recent query on the connection 22 | represented by the link parameter. This function can be useful when using the 23 | &function.mysql_store_result; function to determine if the query should have 24 | produced a non-empty result set or not without knowing the nature of the 25 | query. 26 | 27 | 28 | 29 | &reftitle.parameters; 30 | 31 | 32 | 33 | mysql 34 | ¶m.mysql; 35 | 36 | 37 | 38 | 39 | 40 | &reftitle.retval; 41 | 42 | An unsigned integer representing the number of fields in a result set. 43 | 44 | 45 | 46 | &reftitle.notes; 47 | 48 | 49 | Function &function.mysql_field_count; should be used to determine if there 50 | is a result set available. 51 | 52 | 53 | 54 | 55 | &reftitle.seealso; 56 | 57 | &function.mysql_store_result;, &function.mysql_use_result; 58 | 59 | 60 | 61 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_field_seek.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_field_seek 5 | 6 | 7 | mysql_field_seek 8 | Sets field cursor to a specified field offset 9 | 10 | 11 | &reftitle.description; 12 | 13 | MYSQL_FIELD_OFFSET 14 | mysql_field_seek 15 | 16 | MYSQL_RES * 17 | result 18 | 19 | 20 | MYSQL_FIELD_OFFSET 21 | offset 22 | 23 | 24 | 25 | Sets the field cursor to the given offset. The next call to 26 | &function.mysql_fetch_field; will retrieve the field definition of the column 27 | associated with that offset. 28 | 29 | 30 | 31 | &reftitle.parameters; 32 | 33 | 34 | 35 | result 36 | ¶m.result; 37 | 38 | 39 | offset 40 | The field number. This number must be in the range from 0..number of fields - 1 41 | 42 | 43 | 44 | 45 | 46 | &reftitle.retval; 47 | 48 | The previous value of the field cursor 49 | 50 | 51 | 52 | &reftitle.notes; 53 | 54 | 55 | The number of fields can be obtained from &function.mysql_field_count; 56 | . 57 | 58 | To move the field cursor to the first field 59 | offset 60 | parameter should be null. 61 | 62 | 63 | 64 | 65 | &reftitle.seealso; 66 | 67 | &function.mysql_field_tell; 68 | 69 | 70 | 71 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_field_tell.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_field_tell 5 | 6 | 7 | mysql_field_tell 8 | Get current offset of the field cursor 9 | 10 | 11 | &reftitle.description; 12 | 13 | MYSQL_FIELD_OFFSET 14 | mysql_field_tell 15 | 16 | MYSQL_RES * 17 | result 18 | 19 | 20 | 21 | Return the offset of the field cursor used for the last 22 | &function.mysql_fetch_field; call. This value can be used as a parameter for 23 | the function &function.mysql_field_seek;. 24 | 25 | 26 | 27 | &reftitle.parameters; 28 | 29 | 30 | 31 | result 32 | ¶m.result; 33 | 34 | 35 | 36 | 37 | 38 | &reftitle.retval; 39 | 40 | Returms the current offset of the field cursor 41 | 42 | 43 | 44 | &reftitle.seealso; 45 | 46 | &function.mysql_field_seek; 47 | 48 | 49 | 50 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_free_result.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_free_result 5 | 6 | 7 | mysql_free_result 8 | Frees the memory associated to a result set 9 | 10 | 11 | &reftitle.description; 12 | 13 | void 14 | mysql_free_result 15 | 16 | MYSQL_RES * 17 | result 18 | 19 | 20 | 21 | Frees the memory associated to the specified result set. 22 | 23 | 24 | 25 | &reftitle.parameters; 26 | 27 | 28 | 29 | result 30 | ¶m.result; 31 | 32 | 33 | 34 | 35 | 36 | &reftitle.retval; 37 | 38 | void 39 | 40 | 41 | 42 | &reftitle.version; 43 | 44 | &product_name; 1.0 45 | 46 | 47 | 48 | &reftitle.notes; 49 | 50 | 51 | You should always free your result set with &function.mysql_free_result; as 52 | soon it's not needed anymore 53 | 54 | 55 | Row values obtained by a prior &function.mysql_fetch_row; call will become 56 | invalid after calling &function.mysql_free_result;. 57 | 58 | 59 | 60 | 61 | &reftitle.seealso; 62 | 63 | &function.mysql_store_result;, &function.mysql_use_result; 64 | 65 | 66 | 67 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_get_client_info.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_get_client_info 5 | 6 | 7 | mysql_get_client_info 8 | Get client library info 9 | 10 | 11 | &reftitle.description; 12 | 13 | const char * 14 | mysql_get_client_info 15 | 16 | void 17 | 18 | 19 | 20 | 21 | Returns a string representing the client library version. 22 | 23 | 24 | 25 | &reftitle.retval; 26 | 27 | A string representing the version of the client library 28 | 29 | 30 | 31 | &reftitle.version; 32 | 33 | &product_name; 1.0 34 | 35 | 36 | 37 | &reftitle.notes; 38 | 39 | 40 | To obtain the numeric value of the client library version use 41 | &function.mysql_get_client_version; 42 | 43 | 44 | 45 | 46 | &reftitle.seealso; 47 | 48 | &function.mysql_get_client_version;, &function.mysql_get_host_info;, 49 | &function.mysql_get_proto_info; 50 | 51 | 52 | 53 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_get_client_version.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_get_client_version 5 | 6 | 7 | mysql_get_client_version 8 | Returns a number representing the client library version 9 | 10 | 11 | &reftitle.description; 12 | 13 | unsigned long 14 | mysql_get_client_version 15 | 16 | void 17 | 18 | 19 | 20 | 21 | Returns a number representing the client library version 22 | 23 | 24 | 25 | &reftitle.retval; 26 | 27 | A number representing the version of the client library 28 | 29 | 30 | 31 | &reftitle.version; 32 | 33 | &product_name; 1.0 34 | 35 | 36 | 37 | &reftitle.notes; 38 | 39 | 40 | To obtain a string containing the client library version use 41 | &function.mysql_get_client_info; function. 42 | 43 | 44 | 45 | 46 | &reftitle.seealso; 47 | 48 | &function.mysql_get_client_info; 49 | 50 | 51 | 52 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_get_host_info.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_get_host_info 5 | 6 | 7 | mysql_get_host_info 8 | Returns host information 9 | 10 | 11 | &reftitle.description; 12 | 13 | const char * 14 | mysql_get_host_info 15 | 16 | MYSQL * 17 | mysql 18 | 19 | 20 | 21 | Describes the type of connection in use for the connection, including the 22 | server host name. 23 | 24 | 25 | 26 | &reftitle.parameters; 27 | 28 | 29 | 30 | mysql 31 | ¶m.mysql; 32 | 33 | 34 | 35 | 36 | 37 | &reftitle.retval; 38 | 39 | Returns a string describing the type of MariaDB connection in use for the 40 | connection or NULL if the connection is not valid. 41 | 42 | 43 | 44 | &reftitle.seealso; 45 | 46 | &function.mysql_get_server_version; 47 | 48 | 49 | 50 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_get_proto_info.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_get_proto_info 5 | 6 | 7 | mysql_get_proto_info 8 | Returns the protocol version number 9 | 10 | 11 | &reftitle.description; 12 | 13 | unsigned int 14 | mysql_get_proto_info 15 | 16 | MYSQL * 17 | mysql 18 | 19 | 20 | 21 | Returns the protocol version number for the specified connection 22 | 23 | 24 | 25 | &reftitle.parameters; 26 | 27 | 28 | 29 | mysql 30 | ¶m.mysql; 31 | 32 | 33 | 34 | 35 | 36 | &reftitle.retval; 37 | 38 | The protocol version for the used connection. 39 | 40 | 41 | 42 | &reftitle.notes; 43 | 44 | 45 | The client library doesn't support protocol version 9 and prior. 46 | 47 | 48 | 49 | 50 | &reftitle.seealso; 51 | 52 | &function.mysql_get_host_info; 53 | 54 | 55 | 56 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_get_server_info.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_get_server_info 5 | 6 | 7 | mysql_get_server_info 8 | Get server info 9 | 10 | 11 | &reftitle.description; 12 | 13 | const char * 14 | mysql_get_server_info 15 | 16 | MYSQL * 17 | mysql 18 | 19 | 20 | 21 | Retrieves the server version 22 | 23 | 24 | 25 | &reftitle.parameters; 26 | 27 | 28 | 29 | mysql 30 | ¶m.mysql; 31 | 32 | 33 | 34 | 35 | 36 | &reftitle.retval; 37 | 38 | Returns the server version or NULL on failure. 39 | 40 | 41 | 42 | &reftitle.version; 43 | 44 | &product_name; 1.0 45 | 46 | 47 | 48 | &reftitle.notes; 49 | 50 | 51 | To obtain the numeric server version please use 52 | &function.mysql_get_server_version; 53 | 54 | 55 | 56 | 57 | &reftitle.seealso; 58 | 59 | &function.mysql_get_server_version;, &function.mysql_get_client_info; 60 | 61 | 62 | 63 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_get_server_version.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_get_server_version 5 | 6 | 7 | mysql_get_server_version 8 | Get numeric server version 9 | 10 | 11 | &reftitle.description; 12 | 13 | unsigned long 14 | mysql_get_server_version 15 | 16 | MYSQL * 17 | mysql 18 | 19 | 20 | 21 | Returns an integer representing the version of connected server 22 | 23 | 24 | 25 | &reftitle.parameters; 26 | 27 | 28 | 29 | mysql 30 | ¶m.mysql; 31 | 32 | 33 | 34 | 35 | 36 | &reftitle.retval; 37 | 38 | A long integer containting the version of the connected server. 39 | 40 | 41 | 42 | &reftitle.notes; 43 | 44 | 45 | The form of the version number is 46 | VERSION_MAJOR 47 | * 10000 + 48 | VERSION_MINOR 49 | * 100 + 50 | VERSION_PATCH 51 | 52 | 53 | 54 | 55 | &reftitle.seealso; 56 | 57 | &function.mysql_get_server_info; 58 | 59 | 60 | 61 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_get_ssl_cipher.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_get_ssl_cipher 5 | 6 | 7 | mysql_get_ssl_cipher 8 | Returns the SSL cipher used for the specified connection 9 | 10 | 11 | &reftitle.description; 12 | 13 | const char * 14 | mysql_get_ssl_cipher 15 | 16 | MYSQL * 17 | mysql 18 | 19 | 20 | 21 | Returns the SSL cipher used for the specified connection. 22 | 23 | 24 | 25 | &reftitle.parameters; 26 | 27 | 28 | 29 | mysql 30 | ¶m.mysql; 31 | 32 | 33 | 34 | 35 | 36 | &reftitle.retval; 37 | 38 | Returns the SSL cipher used for the specified connection or NULL if the specified connection doesn't use SSL encryption. 39 | 40 | 41 | 42 | &reftitle.version; 43 | 44 | &product_name; 1.1 45 | 46 | 47 | 48 | &reftitle.notes; 49 | 50 | 51 | 52 | 53 | 54 | See also &function.mysql_ssl_set; 55 | 56 | 57 | 58 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_init.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_init 5 | 6 | 7 | mysql_init 8 | Initialize a connection 9 | 10 | 11 | &reftitle.description; 12 | 13 | MYSQL * 14 | mysql_init 15 | 16 | MYSQL * 17 | mysql 18 | 19 | 20 | 21 | Prepares and initializes a MYSQL structure to be used with 22 | &function.mysql_real_connect;. 23 | 24 | 25 | If &function.mysql_thread_init; was not called before, &function.mysql_init; 26 | will also initialize the thread subsystem for the current thread. 27 | 28 | 29 | 30 | &reftitle.parameters; 31 | 32 | 33 | 34 | mysql 35 | A pointer to MYSQL or NULL. In case of passing a NULL pointer &function.mysql_init; will allocate memory and return a pointer to a MYSQL structure. 36 | 37 | 38 | 39 | 40 | 41 | &reftitle.retval; 42 | 43 | A pointer to a MYSQL structure or NULL if an error occured. 44 | 45 | 46 | 47 | &reftitle.notes; 48 | 49 | 50 | Any subsequent calls to any mysql function (except &function.mysql_options;) 51 | will fail until &function.mysql_real_connect; was called. 52 | 53 | 54 | Memory allocated by &function.mysql_init; must be freed with 55 | &function.mysql_close;. 56 | 57 | 58 | 59 | 60 | &reftitle.seealso; 61 | 62 | &function.mysql_real_connect;, &function.mysql_options;, 63 | &function.mysql_thread_init;, &function.mysql_close;, 64 | 65 | 66 | 67 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_insert_id.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_insert_id 5 | 6 | 7 | mysql_insert_id 8 | Returns the auto generated id used in the last query 9 | 10 | 11 | &reftitle.description; 12 | 13 | my_ulonglong 14 | mysql_insert_id 15 | 16 | MYSQL * 17 | mysql 18 | 19 | 20 | 21 | The &function.mysql_insert_id; function returns the ID generated by a query 22 | on a table with a column having the AUTO_INCREMENT attribute. If the last 23 | query wasn't an INSERT or UPDATE statement or if the modified table does not 24 | have a column with the AUTO_INCREMENT attribute, this function will return 25 | zero. 26 | 27 | 28 | 29 | &reftitle.parameters; 30 | 31 | 32 | 33 | mysql 34 | ¶m.mysql; 35 | 36 | 37 | 38 | 39 | 40 | &reftitle.retval; 41 | 42 | The value of the AUTO_INCREMENT field that was updated by the previous query. 43 | Returns zero if there was no previous query on the connection or if the query 44 | did not update an AUTO_INCREMENT value. 45 | 46 | 47 | 48 | &reftitle.notes; 49 | 50 | 51 | Performing an INSERT or UPDATE statement using the LAST_INSERT_ID() function 52 | will also modify the value returned by the &function.mysql_insert_id; 53 | function. 54 | 55 | 56 | When performing a multi insert statement, &function.mysql_insert_id; will 57 | return the value of the first row. 58 | 59 | 60 | 61 | 62 | &reftitle.seealso; 63 | 64 | &function.mysql_stmt_insert_id; 65 | 66 | 67 | 68 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_kill.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_kill 5 | 6 | 7 | mysql_kill 8 | Asks the server to kill a connection thread. 9 | 10 | 11 | &reftitle.description; 12 | 13 | int 14 | mysql_kill 15 | 16 | MYSQL * 17 | mysql 18 | 19 | 20 | unsigned 21 | long 22 | 23 | 24 | 25 | This function is used to ask the server to kill a MariaDB thread specified by 26 | the processid parameter. This value must be retrieved by 27 | SHOW PROCESSLIST 28 | or if the own connection should be killed by &function.mysql_thread_id;. 29 | 30 | 31 | 32 | &reftitle.parameters; 33 | 34 | 35 | 36 | mysql 37 | ¶m.mysql; 38 | 39 | 40 | long 41 | process id 42 | 43 | 44 | 45 | 46 | 47 | &reftitle.retval; 48 | 49 | Returns 0 on success, otherwise nonzero. 50 | 51 | 52 | 53 | &reftitle.notes; 54 | 55 | 56 | To stop a running command without killing the connection use 57 | KILL QUERY 58 | . 59 | 60 | 61 | &function.mysql_kill; function only kills a connection, it doesn't free any 62 | memory - this must be done explicitly by calling &function.mysql_close; 63 | 64 | 65 | 66 | 67 | &reftitle.seealso; 68 | 69 | &function.mysql_thread_id;, &function.mysql_close; 70 | 71 | 72 | 73 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_library_end.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_library_end 5 | 6 | 7 | mysql_server_end 8 | finalizes the client library. 9 | 10 | 11 | &reftitle.description; 12 | 13 | void 14 | mysql_library_end 15 | 16 | void 17 | 18 | 19 | 20 | 21 | Finalizes the client library. For a complete description see 22 | &function.mysql_server_end; 23 | 24 | 25 | 26 | &reftitle.notes; 27 | 28 | mysql_library_end() 29 | is an alias for &function.mysql_server_end; and defined in 30 | mysql.h 31 | : 32 | 33 | 34 | #define mysql_library_end mysql_server_end 35 | 36 | 37 | 38 | &reftitle.seealso; 39 | 40 | &function.mysql_server_end;, &function.mysql_library_init;, 41 | &function.mysql_library_end; 42 | 43 | 44 | 45 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_library_init.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_library_init 5 | 6 | 7 | mysql_server_end 8 | initializes the client library. 9 | 10 | 11 | &reftitle.description; 12 | 13 | void 14 | mysql_library_init 15 | 16 | void 17 | 18 | 19 | 20 | 21 | Initializes the client library. For a complete description see 22 | &function.mysql_server_init; 23 | 24 | 25 | 26 | &reftitle.notes; 27 | 28 | mysql_library_init() 29 | is an alias for &function.mysql_server_init; and defined in 30 | mysql.h 31 | : 32 | 33 | 34 | #define mysql_library_init mysql_server_init 35 | 36 | 37 | 38 | &reftitle.seealso; 39 | 40 | &function.mysql_server_end;, &function.mysql_server_init;, 41 | &function.mysql_library_end; 42 | 43 | 44 | 45 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_more_results.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_more_results 5 | 6 | 7 | mysql_more_results 8 | Check if there are any more query results from a multi query 9 | 10 | 11 | &reftitle.description; 12 | 13 | my_bool 14 | mysql_more_results 15 | 16 | MYSQL * 17 | mysql 18 | 19 | 20 | 21 | Indicates if one or more result sets are available from a previous call to 22 | &function.mysql_real_query;. 23 | 24 | 25 | 26 | &reftitle.parameters; 27 | 28 | 29 | 30 | mysql 31 | ¶m.mysql; 32 | 33 | 34 | 35 | 36 | 37 | &reftitle.retval; 38 | 39 | Returns 1 if more result sets are available, otherwise zero. 40 | 41 | 42 | 43 | &reftitle.notes; 44 | 45 | 46 | The function &function.mysql_set_server_option; enables or disables multi 47 | statement support. 48 | 49 | 50 | 51 | 52 | &reftitle.seealso; 53 | 54 | &function.mysql_real_query;, &function.mysql_use_result;, 55 | &function.mysql_store_result;, &function.mysql_next_result; 56 | 57 | 58 | 59 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_next_result.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_next_result 5 | 6 | 7 | mysql_next_result 8 | Prepares next result set from a multi query 9 | 10 | 11 | &reftitle.description; 12 | 13 | int 14 | mysql_next_result 15 | 16 | MYSQL * 17 | mysql 18 | 19 | 20 | 21 | Prepares next result set from a previous call to &function.mysql_real_query; 22 | which can be retrieved by &function.mysql_store_result; or 23 | &function.mysql_use_result;. 24 | 25 | 26 | 27 | &reftitle.parameters; 28 | 29 | 30 | 31 | mysql 32 | ¶m.mysql; 33 | 34 | 35 | 36 | 37 | 38 | &reftitle.retval; 39 | 40 | &return.my_bool; 41 | 42 | 43 | 44 | &reftitle.notes; 45 | 46 | 47 | If a multi query contains errors the return value of &function.mysql_errno; 48 | and &function.mysql_error; might change and there will be no result set 49 | available 50 | 51 | 52 | 53 | 54 | &reftitle.seealso; 55 | 56 | &function.mysql_store_result; &function.mysql_more_results; 57 | 58 | 59 | 60 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_num_fields.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_num_fields 5 | 6 | 7 | mysql_num_fields 8 | returns number of fields in a result set 9 | 10 | 11 | &reftitle.description; 12 | 13 | unsigned int 14 | mysql_num_fields 15 | 16 | MYSQL_RES * 17 | 18 | 19 | 20 | 21 | Returns number of fields in a specified result set. 22 | 23 | 24 | 25 | &reftitle.parameters; 26 | 27 | 28 | 29 | 30 | ¶m.result; 31 | 32 | 33 | 34 | 35 | 36 | &reftitle.retval; 37 | 38 | The number of fields in a result set. 39 | 40 | 41 | 42 | &reftitle.seealso; 43 | 44 | &function.mysql_fetch_field; 45 | 46 | 47 | 48 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_num_rows.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_num_rows 5 | 6 | 7 | mysql_num_rows 8 | Returns number of rows in a result set. 9 | 10 | 11 | &reftitle.description; 12 | 13 | my_ulonglong 14 | mysql_num_rows 15 | 16 | MYSQL_RES * 17 | 18 | 19 | 20 | 21 | Returns the number of rows in a result set. 22 | 23 | 24 | 25 | &reftitle.parameters; 26 | 27 | 28 | 29 | 30 | ¶m.result; 31 | 32 | 33 | 34 | 35 | 36 | &reftitle.retval; 37 | 38 | The number of rows in a result set. 39 | 40 | 41 | 42 | &reftitle.notes; 43 | 44 | 45 | The behaviour of &function.mysql_num_rows; depends on whether buffered or 46 | unbuffered result sets are being used. For unbuffered result sets, 47 | &function.mysql_num_rows; will not return the correct number of rows until 48 | all the rows in the result have been retrieved. 49 | 50 | 51 | 52 | 53 | &reftitle.seealso; 54 | 55 | &function.mysql_use_result;, &function.mysql_store_result; 56 | 57 | 58 | 59 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_options4.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_options4 5 | 6 | 7 | mysql_options4 8 | Set options (with additional 4th parameter) 9 | 10 | 11 | &reftitle.description; 12 | 13 | int 14 | mysql_options4 15 | 16 | MYSQL * 17 | mysql 18 | 19 | 20 | enum 21 | mysql_option 22 | 23 | 24 | const void * 25 | arg1 26 | 27 | 28 | const void * 29 | arg2 30 | 31 | 32 | 33 | This function is deprecated, please use &function.mysql_optionsv; instead. 34 | 35 | 36 | 37 | &reftitle.seealso; 38 | 39 | &function.mysql_optionsv;, &function.mysql_options; 40 | 41 | 42 | 43 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_ping.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_ping 5 | 6 | 7 | mysql_ping 8 | Pings a server connection 9 | 10 | 11 | &reftitle.description; 12 | 13 | int 14 | mysql_ping 15 | 16 | MYSQL * 17 | mysql 18 | 19 | 20 | 21 | Checks whether the connection to the server is working. If it has gone down, 22 | and global option 23 | 24 | is enabled an automatic reconnection is attempted. 25 | 26 | 27 | This function can be used by clients that remain idle for a long while, to 28 | check whether the server has closed the connection and reconnect if 29 | necessary. 30 | 31 | 32 | 33 | &reftitle.parameters; 34 | 35 | 36 | 37 | mysql 38 | ¶m.mysql; 39 | 40 | 41 | 42 | 43 | 44 | &reftitle.retval; 45 | 46 | &return.my_bool; 47 | 48 | 49 | 50 | &reftitle.notes; 51 | 52 | 53 | If a reconnect occured the 54 | thread_id 55 | will change. Also resources bundled to the connection (prepared statements, 56 | locks, temporary tables, ...) will be released. 57 | 58 | 59 | 60 | 61 | &reftitle.seealso; 62 | 63 | &function.mysql_options;, &function.mysql_kill; 64 | 65 | 66 | 67 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_read_query_result.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_read_query_result 5 | 6 | 7 | mysql_read_query_result 8 | Reads a result set package from server 9 | 10 | 11 | &reftitle.description; 12 | 13 | my_bool 14 | mysql_read_query_result 15 | 16 | MYSQL * 17 | mysql 18 | 19 | 20 | 21 | Waits for a server result set or response package from a previously executed &function.mysql_send_query;. 22 | 23 | 24 | 25 | &reftitle.parameters; 26 | 27 | 28 | 29 | mysql 30 | ¶m.mysql; 31 | 32 | 33 | 34 | 35 | 36 | &reftitle.retval; 37 | 38 | Zero on success, otherwise non zero 39 | 40 | 41 | 42 | &reftitle.seealso; 43 | 44 | &function.mysql_send_query; 45 | 46 | 47 | 48 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_reload.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_reload 5 | 6 | 7 | mysql_reload 8 | reloads server grant tables 9 | 10 | 11 | &reftitle.description; 12 | 13 | int 14 | mysql_reload 15 | 16 | MYSQL * 17 | mysql 18 | 19 | 20 | 21 | The 22 | mysql_reload() 23 | reloads database grant tables. 24 | . 25 | 26 | 27 | &reftitle.parameters; 28 | 29 | 30 | 31 | mysql 32 | ¶m.mysql; 33 | 34 | 35 | 36 | 37 | 38 | &reftitle.retval; 39 | 40 | Zero on success, otherweise non zero. 41 | 42 | 43 | 44 | &reftitle.notes; 45 | 46 | &reftitle.notes; 47 | 48 | mysql_reload() 49 | is a macro for &function.mysql_refresh;, defined in 50 | mysql.h 51 | : 52 | 53 | 54 | #define mysql_reload(mysql) mysql_refresh((mysql),REFRESH_GRANT) 55 | 56 | 57 | 58 | 59 | &reftitle.seealso; 60 | 61 | &function.mysql_refresh; 62 | 63 | 64 | 65 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_rollback.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_rollback 5 | 6 | 7 | mysql_rollback 8 | Rolls back current transaction 9 | 10 | 11 | &reftitle.description; 12 | 13 | my_bool 14 | mysql_rollback 15 | 16 | MYSQL * 17 | mysql 18 | 19 | 20 | 21 | Rolls back the current transaction for the database. 22 | 23 | 24 | 25 | &reftitle.parameters; 26 | 27 | 28 | 29 | mysql 30 | ¶m.mysql; 31 | 32 | 33 | 34 | 35 | 36 | &reftitle.retval; 37 | 38 | &return.my_bool; 39 | 40 | 41 | 42 | &reftitle.notes; 43 | 44 | 45 | &function.mysql_rollback; will not work as expected if autocommit mode was 46 | set or the storage engine does not support transactions. 47 | 48 | 49 | 50 | 51 | &reftitle.seealso; 52 | 53 | &function.mysql_commit;, &function.mysql_autocommit; 54 | 55 | 56 | 57 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_row_seek.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_row_seek 5 | 6 | 7 | mysql_row_seek 8 | Positions row cursor 9 | 10 | 11 | &reftitle.description; 12 | 13 | MYSQL_ROW_OFFSET 14 | mysql_row_seek 15 | 16 | MYSQL_RES * 17 | result 18 | 19 | 20 | MYSQL_ROW_OFFSET 21 | offset 22 | 23 | 24 | 25 | Positions the row cursor to an aribtrary row in a result set which was 26 | obtaimed by &function.mysql_store_result;. 27 | 28 | 29 | 30 | &reftitle.parameters; 31 | 32 | 33 | 34 | result 35 | ¶m.result_store; 36 | 37 | 38 | offset 39 | Row offset. This value can be obtained either by &function.mysql_row_seek; or &function.mysql_row_tell; 40 | 41 | 42 | 43 | 44 | 45 | &reftitle.retval; 46 | 47 | The previous row offset. 48 | 49 | 50 | 51 | &reftitle.notes; 52 | 53 | 54 | This function will not work if the result set was obtained by 55 | &function.mysql_use_result;. 56 | 57 | 58 | 59 | 60 | &reftitle.seealso; 61 | 62 | &function.mysql_store_result;, &function.mysql_row_tell; 63 | 64 | 65 | 66 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_row_tell.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_row_tell 5 | 6 | 7 | mysql_row_tell 8 | Returns position of result cursor 9 | 10 | 11 | &reftitle.description; 12 | 13 | MYSQL_ROW_OFFSET 14 | mysql_row_tell 15 | 16 | MYSQL_RES * 17 | res 18 | 19 | 20 | 21 | Returns the row offset of a result cursor. The returned offset value can be 22 | used to reposition the result cursor by calling &function.mysql_row_seek; 23 | 24 | 25 | 26 | &reftitle.parameters; 27 | 28 | 29 | 30 | res 31 | ¶m.result_store; 32 | 33 | 34 | 35 | 36 | 37 | &reftitle.retval; 38 | 39 | The row offset of the result cursor 40 | 41 | 42 | 43 | &reftitle.notes; 44 | 45 | 46 | This function will not work if the result set was obtained by 47 | &function.mysql_use_result;. 48 | 49 | 50 | 51 | 52 | &reftitle.seealso; 53 | 54 | &function.mysql_store_result;, &function.mysql_row_seek; 55 | 56 | 57 | 58 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_select_db.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_select_db 5 | 6 | 7 | mysql_select_db 8 | Selects a database as default 9 | 10 | 11 | &reftitle.description; 12 | 13 | int 14 | mysql_select_db 15 | 16 | MYSQL * 17 | mysql 18 | 19 | 20 | const char * 21 | db 22 | 23 | 24 | 25 | Sets the current active database on the server that's associated with the 26 | specified link identifier. Every subsequent api call will be made on the 27 | active database. 28 | 29 | 30 | 31 | &reftitle.parameters; 32 | 33 | 34 | 35 | mysql 36 | ¶m.mysql; 37 | 38 | 39 | db 40 | The default database name 41 | 42 | 43 | 44 | 45 | 46 | &reftitle.retval; 47 | 48 | Zero on success, non-zero on failure 49 | 50 | 51 | 52 | &reftitle.notes; 53 | 54 | 55 | The SQL command 56 | SELECT DATABASE() 57 | will return the name of the default database. 58 | 59 | 60 | The default database can also be set by the 61 | db 62 | parameter in &function.mysql_real_connect;. 63 | 64 | 65 | 66 | 67 | &reftitle.seealso; 68 | 69 | &function.mysql_real_connect; 70 | 71 | 72 | 73 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_server_end.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_server_end 5 | 6 | 7 | mysql_server_end 8 | An alias for mysql_library_end() 9 | 10 | 11 | &reftitle.description; 12 | 13 | void 14 | mysql_server_end 15 | 16 | void 17 | 18 | 19 | 20 | 21 | An alias for &function.mysql_library_end; 22 | 23 | 24 | 25 | &reftitle.seealso; 26 | 27 | &function.mysql_server_end;, &function.mysql_library_init;, 28 | &function.mysql_library_end; 29 | 30 | 31 | 32 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_server_init.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_server_init 5 | 6 | 7 | mysql_server_init 8 | An alias for mysql_library_init() 9 | 10 | 11 | &reftitle.description; 12 | 13 | int 14 | mysql_server_init 15 | 16 | int 17 | argc 18 | 19 | 20 | char * 21 | 22 | 23 | 24 | char * 25 | 26 | 27 | 28 | 29 | This is an alias for &function.mysql_library_init; 30 | 31 | 32 | 33 | &reftitle.seealso; 34 | 35 | &function.mysql_server_end;, &function.mysql_library_init;, 36 | &function.mysql_library_end; 37 | 38 | 39 | 40 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_shutdown.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_shutdown 5 | 6 | 7 | mysql_shutdown 8 | Shutdowns the database server 9 | 10 | 11 | &reftitle.description; 12 | 13 | int 14 | mysql_shutdown 15 | 16 | MYSQL * 17 | mysql 18 | 19 | 20 | enum 21 | mysql_enum_shutdown_level 22 | 23 | 24 | 25 | Sends a shutdown message to the server. 26 | 27 | 28 | 29 | &reftitle.parameters; 30 | 31 | 32 | 33 | mysql 34 | ¶m.mysql; 35 | 36 | 37 | mysql_enum_shutdown_level 38 | Currently only one shutdown level, SHUTDOWN_DEFAULT is supported. 39 | 40 | 41 | 42 | 43 | 44 | &reftitle.retval; 45 | 46 | Zero on success, non-zero on failure. 47 | 48 | 49 | 50 | &reftitle.notes; 51 | 52 | 53 | To shutdown the database server, the user for the current connection must 54 | have 55 | SHUTDOWN 56 | privileges 57 | 58 | 59 | 60 | 61 | &reftitle.seealso; 62 | 63 | &function.mysql_kill; 64 | 65 | 66 | 67 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_sqlstate.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_sqlstate 5 | 6 | 7 | mysql_sqlstate 8 | Returns sqlstate error 9 | 10 | 11 | &reftitle.description; 12 | 13 | const char * 14 | mysql_sqlstate 15 | 16 | MYSQL * 17 | mysql 18 | 19 | 20 | 21 | Returns a string containing the SQLSTATE error code for the most recently 22 | invoked function that can succeed or fail. The error code consists of five 23 | characters. '00000' means no error. The values are specified by ANSI SQL and 24 | ODBC 25 | 26 | 27 | 28 | &reftitle.parameters; 29 | 30 | 31 | 32 | mysql 33 | ¶m.mysql; 34 | 35 | 36 | 37 | 38 | 39 | &reftitle.retval; 40 | 41 | Returns a string containing the SQLSTATE error code for the last error. The 42 | error code consists of five characters. ' 43 | 00000' 44 | means no error. 45 | 46 | 47 | 48 | &reftitle.notes; 49 | 50 | 51 | Please note that not all &product_name; error codes are mapped to SQLSTATE 52 | errors. Errors which can't be mapped will returned as value 53 | HY000 54 | . 55 | 56 | 57 | 58 | 59 | &reftitle.seealso; 60 | 61 | &function.mysql_error;, &function.mysql_errno; 62 | 63 | 64 | 65 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_stat.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_stat 5 | 6 | 7 | mysql_stat 8 | returns system status 9 | 10 | 11 | &reftitle.description; 12 | 13 | const char * 14 | mysql_stat 15 | 16 | MYSQL * 17 | mysql 18 | 19 | 20 | 21 | &function.mysql_stat; returns the current server status. 22 | 23 | 24 | 25 | &reftitle.parameters; 26 | 27 | 28 | 29 | mysql 30 | ¶m.mysql; 31 | 32 | 33 | 34 | 35 | 36 | &reftitle.retval; 37 | 38 | Returns a string with the status for uptime, threads, queries, open tables, 39 | flush tables and queries per second. 40 | 41 | 42 | 43 | &reftitle.notes; 44 | 45 | 46 | For a complete list of other status variables, you have to use the 47 | SHOW STATUS 48 | SQL command 49 | 50 | 51 | 52 | 53 | &reftitle.seealso; 54 | 55 | &function.mysql_get_server_info; 56 | 57 | 58 | 59 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_stmt_bind_param.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_stmt_bind_param 5 | 6 | 7 | mysql_stmt_bind_param 8 | Binds parameter variables to a prepared statement 9 | 10 | 11 | &reftitle.description; 12 | 13 | my_bool 14 | mysql_stmt_bind_param 15 | 16 | MYSQL_STMT * 17 | stmt 18 | 19 | 20 | MYSQL_BIND * 21 | bnd 22 | 23 | 24 | 25 | Binds variables for parameter markers in the prepared statement that was 26 | passed to &function.mysql_stmt_prepare;. Variabl 27 | 28 | 29 | 30 | &reftitle.parameters; 31 | 32 | 33 | 34 | stmt 35 | ¶m.stmt; 36 | 37 | 38 | bind 39 | An array of MYSQL_BIND structures. The size of this array must be equal to the number of parameters. 40 | 41 | 42 | 43 | 44 | 45 | &reftitle.retval; 46 | 47 | Zero on success, non-zero on failure. 48 | 49 | 50 | 51 | &reftitle.notes; 52 | 53 | 54 | The number of parameters can be obtained by 55 | &function.mysql_stmt_param_count;. 56 | 57 | 58 | 59 | 60 | &reftitle.seealso; 61 | 62 | &function.mysql_stmt_prepare;, &function.mysql_stmt_bind_result;, 63 | &function.mysql_stmt_execute;, &function.mysql_stmt_param_count;, 64 | &function.mysql_stmt_send_long_data; 65 | 66 | 67 | 68 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_stmt_close.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_stmt_close 5 | 6 | 7 | mysql_stmt_close 8 | Closes a prepared statement 9 | 10 | 11 | &reftitle.description; 12 | 13 | my_bool 14 | mysql_stmt_close 15 | 16 | MYSQL_STMT * 17 | stmt 18 | 19 | 20 | 21 | Closes a prepared statement. &function.mysql_stmt_close; also deallocates the 22 | statement handle. If the current statement has pending or unread results, 23 | this function cancels them so that the next query can be executed. 24 | 25 | 26 | 27 | &reftitle.parameters; 28 | 29 | 30 | 31 | stmt 32 | ¶m.stmt; 33 | 34 | 35 | 36 | 37 | 38 | &reftitle.retval; 39 | 40 | &return.my_bool; 41 | 42 | 43 | 44 | &reftitle.notes; 45 | 46 | 47 | If you want to reuse the statement handle with a different SQL command, use 48 | &function.mysql_stmt_reset;. 49 | 50 | 51 | 52 | 53 | &reftitle.seealso; 54 | 55 | &function.mysql_stmt_init;&function.mysql_stmt_reset; 56 | 57 | 58 | 59 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_stmt_data_seek.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_stmt_data_seek 5 | 6 | 7 | mysql_stmt_data_seek 8 | Seeks to an arbitrary row in statement result set 9 | 10 | 11 | &reftitle.description; 12 | 13 | void 14 | mysql_stmt_data_seek 15 | 16 | MYSQL_STMT * 17 | stmt 18 | 19 | 20 | my_ulonglong 21 | offset 22 | 23 | 24 | 25 | Seeks to an arbitrary row in statement result set obtained by a previous call 26 | to &function.mysql_stmt_store_result;. 27 | 28 | 29 | 30 | &reftitle.parameters; 31 | 32 | 33 | 34 | stmt 35 | ¶m.stmt; 36 | 37 | 38 | offset 39 | Row offset. This value must between 0 and number of rows - 1. 40 | 41 | 42 | 43 | 44 | 45 | &reftitle.retval; 46 | 47 | void 48 | 49 | 50 | 51 | &reftitle.notes; 52 | 53 | 54 | The number of rows can be obtained by function 55 | &function.mysql_stmt_num_rows;. 56 | 57 | 58 | 59 | 60 | &reftitle.seealso; 61 | 62 | &function.mysql_stmt_row_tell;, &function.mysql_stmt_store_result;, 63 | &function.mysql_stmt_num_rows; 64 | 65 | 66 | 67 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_stmt_errno.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_stmt_errno 5 | 6 | 7 | mysql_stmt_errno 8 | Returns the error number for the most recent prepared statement call 9 | 10 | 11 | &reftitle.description; 12 | 13 | unsigned int 14 | mysql_stmt_errno 15 | 16 | MYSQL_STMT * 17 | stmt 18 | 19 | 20 | 21 | Returns the error code for the most recently invoked statement function that 22 | can succeed or fail. 23 | 24 | 25 | 26 | &reftitle.parameters; 27 | 28 | 29 | 30 | stmt 31 | ¶m.stmt; 32 | 33 | 34 | 35 | 36 | 37 | &reftitle.retval; 38 | 39 | An error code value for the last call, if it failed. zero means no error 40 | occurred. 41 | 42 | 43 | 44 | &reftitle.notes; 45 | 46 | 47 | Client error messages are listed in 48 | errmsg.h 49 | header file, server error messages are listed in 50 | mysqld_error.h 51 | header file of the server source distribution. 52 | 53 | 54 | 55 | 56 | &reftitle.seealso; 57 | 58 | &function.mysql_stmt_error;, &function.mysql_stmt_sqlstate; 59 | 60 | 61 | 62 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_stmt_error.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_stmt_error 5 | 6 | 7 | mysql_stmt_error 8 | Returns a string description for last statement error 9 | 10 | 11 | &reftitle.description; 12 | 13 | const char * 14 | mysql_stmt_error 15 | 16 | MYSQL_STMT * 17 | stmt 18 | 19 | 20 | 21 | Returns a containing the error message for the most recently invoked 22 | statement function that can succeed or fail. 23 | 24 | 25 | 26 | &reftitle.parameters; 27 | 28 | 29 | 30 | stmt 31 | ¶m.stmt; 32 | 33 | 34 | 35 | 36 | 37 | &reftitle.retval; 38 | 39 | A string that describes the error. An empty string if no error occurred. 40 | 41 | 42 | 43 | &reftitle.notes; 44 | 45 | 46 | Client error messages are listed in 47 | errmsg.h 48 | header file, server error messages are listed in 49 | mysqld_error.h 50 | header file of the server source distribution. 51 | 52 | 53 | 54 | 55 | &reftitle.seealso; 56 | 57 | &function.mysql_stmt_errno;, &function.mysql_stmt_sqlstate; 58 | 59 | 60 | 61 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_stmt_execute.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_stmt_execute 5 | 6 | 7 | mysql_stmt_execute 8 | Executes a prepared statement 9 | 10 | 11 | &reftitle.description; 12 | 13 | int 14 | mysql_stmt_execute 15 | 16 | MYSQL_STMT * 17 | stmt 18 | 19 | 20 | 21 | Executes a prepared statement which was previously prepared by 22 | &function.mysql_stmt_prepare;. When executed any parameter markers which 23 | exist will automatically be replaced with the appropriate data. 24 | 25 | 26 | 27 | &reftitle.parameters; 28 | 29 | 30 | 31 | stmt 32 | ¶m.stmt; 33 | 34 | 35 | 36 | 37 | 38 | &reftitle.retval; 39 | 40 | Zero on success, non-zero on failure. 41 | 42 | 43 | 44 | &reftitle.notes; 45 | 46 | 47 | If the statement is UPDATE, DELETE, or INSERT, the total number of affected 48 | rows can be determined by using the &function.mysql_stmt_affected_rows; 49 | function. Likewise, if the query yields a result set the 50 | &function.mysql_stmt_fetch; function is used. 51 | 52 | 53 | 54 | 55 | &reftitle.seealso; 56 | 57 | &function.mysql_stmt_prepare;, &function.mysql_stmt_bind_param; 58 | 59 | 60 | 61 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_stmt_field_count.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_stmt_field_count 5 | 6 | 7 | mysql_stmt_field_count 8 | Returns the number of fields in a result set of a prepared statement 9 | 10 | 11 | &reftitle.description; 12 | 13 | unsigned int 14 | mysql_stmt_field_count 15 | 16 | MYSQL_STMT * 17 | stmt 18 | 19 | 20 | 21 | Returns the number of fields in a result set of a prepared statement. 22 | 23 | 24 | 25 | &reftitle.parameters; 26 | 27 | 28 | 29 | stmt 30 | ¶m.stmt; 31 | 32 | 33 | 34 | 35 | 36 | &reftitle.retval; 37 | 38 | The number of fields in a result set. 39 | 40 | 41 | 42 | &reftitle.notes; 43 | 44 | 45 | The number of fields will be available after calling 46 | &function.mysql_stmt_prepare;. 47 | 48 | 49 | &function.mysql_stmt_field_count; returns zero for UPSERT statements which 50 | doesn't produce a result set. 51 | 52 | 53 | 54 | 55 | &reftitle.seealso; 56 | 57 | &function.mysql_stmt_prepare;, &function.mysql_stmt_param_count; 58 | 59 | 60 | 61 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_stmt_free_result.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_stmt_free_result 5 | 6 | 7 | mysql_stmt_free_result 8 | Frees stored result memory of a prepared statement 9 | 10 | 11 | &reftitle.description; 12 | 13 | my_bool 14 | mysql_stmt_free_result 15 | 16 | MYSQL_STMT * 17 | stmt 18 | 19 | 20 | 21 | Returns the number of fields in a result set of a prepared statement, which 22 | was allocated by &function.mysql_stmt_store_result;. 23 | 24 | 25 | 26 | &reftitle.parameters; 27 | 28 | 29 | 30 | stmt 31 | ¶m.stmt; 32 | 33 | 34 | 35 | 36 | 37 | &reftitle.retval; 38 | 39 | void 40 | 41 | 42 | 43 | &reftitle.seealso; 44 | 45 | &function.mysql_stmt_store_result; 46 | 47 | 48 | 49 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_stmt_init.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_stmt_init 5 | 6 | 7 | mysql_stmt_init 8 | Initializes a prepared statement 9 | 10 | 11 | &reftitle.description; 12 | 13 | MYSQL_STMT * 14 | mysql_stmt_init 15 | 16 | MYSQL * 17 | mysql 18 | 19 | 20 | 21 | Initializes and allocates memory for a prepared statement. 22 | 23 | 24 | 25 | &reftitle.parameters; 26 | 27 | 28 | 29 | mysql 30 | ¶m.mysql; 31 | 32 | 33 | 34 | 35 | 36 | &reftitle.retval; 37 | 38 | A pointer to a MYSQL_STMT structure or NULL if an error occured. 39 | 40 | 41 | 42 | &reftitle.notes; 43 | 44 | 45 | A statement handle which was allocated by &function.mysql_stmt_init; needs 46 | to be freed with &function.mysql_stmt_close;. 47 | 48 | 49 | Any subsequent calls to any mysql_stmt function will fail until 50 | &function.mysql_stmt_prepare; was called. 51 | 52 | 53 | 54 | 55 | &reftitle.seealso; 56 | 57 | &function.mysql_stmt_close;, &function.mysql_stmt_prepare; 58 | 59 | 60 | 61 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_stmt_insert_id.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_stmt_insert_id 5 | 6 | 7 | mysql_stmt_insert_id 8 | Get the auto generated id from previously executed prepared statement. 9 | 10 | 11 | &reftitle.description; 12 | 13 | my_ulonglong 14 | mysql_stmt_insert_id 15 | 16 | MYSQL_STMT * 17 | stmt 18 | 19 | 20 | 21 | The &function.mysql_stmt_insert_id; function returns the ID generated by a 22 | prepared statement on a table with a column having the AUTO_INCREMENT 23 | attribute. If the last query wasn't an INSERT or UPDATE statement or if the 24 | modified table does not have a column with the AUTO_INCREMENT attribute, this 25 | function will return zero. 26 | 27 | 28 | 29 | &reftitle.parameters; 30 | 31 | 32 | 33 | stmt 34 | ¶m.stmt; 35 | 36 | 37 | 38 | 39 | 40 | &reftitle.retval; 41 | 42 | The last generated id. 43 | 44 | 45 | 46 | &reftitle.notes; 47 | 48 | 49 | When performing a multi insert preapred statement, 50 | &function.mysql_stmt_insert_id; will return the value of the first row. 51 | 52 | 53 | 54 | 55 | &reftitle.seealso; 56 | 57 | &function.mysql_insert_id; 58 | 59 | 60 | 61 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_stmt_more_results.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_stmt_more_results 5 | 6 | 7 | mysql_stmt_more_results 8 | Check if there are any more query results from a prepared statement 9 | 10 | 11 | &reftitle.description; 12 | 13 | my_bool 14 | mysql_more_results 15 | 16 | MYSQL_STMT * 17 | stmt 18 | 19 | 20 | 21 | Indicates if one or more result sets are available from a previous call to 22 | &function.mysql_stmt_execute;. 23 | 24 | 25 | 26 | &reftitle.parameters; 27 | 28 | 29 | 30 | stmt 31 | A statement which was previosly executed by &function.mysql_stmt_execute; 32 | 33 | 34 | 35 | 36 | 37 | &reftitle.retval; 38 | 39 | Returns 1 if more result sets are available, otherwise zero. 40 | 41 | 42 | 43 | &reftitle.notes; 44 | 45 | 46 | Prepared statements don't support execution of multi statements. 47 | 48 | 49 | Multiple result sets can be obtained by executing a stored procedure 50 | 51 | 52 | When using prepared statements out parameters for stored procedures are 53 | returned as a result set. 54 | 55 | 56 | 57 | 58 | &reftitle.seealso; 59 | 60 | &function.mysql_stmt_execute;, &function.mysql_stmt_store_result;, 61 | &function.mysql_stmt_next_result; 62 | 63 | 64 | 65 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_stmt_next_result.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_stmt_next_result 5 | 6 | 7 | mysql_stmt_next_result 8 | Prepares next result set from a stored procedure 9 | 10 | 11 | &reftitle.description; 12 | 13 | int 14 | mysql_stmt_next_result 15 | 16 | MYSQL_STMT * 17 | stmt 18 | 19 | 20 | 21 | Prepares next result set from a previous call to 22 | &function.mysql_stmt_execute;. 23 | 24 | 25 | 26 | &reftitle.parameters; 27 | 28 | 29 | 30 | stmt 31 | ¶m.mysql; 32 | 33 | 34 | 35 | 36 | 37 | &reftitle.retval; 38 | 39 | &return.my_bool; 40 | 41 | 42 | 43 | &reftitle.notes; 44 | 45 | 46 | If a multi result set contains errors the return value of 47 | &function.mysql_errno; and &function.mysql_error; might change and there 48 | will be no result set available 49 | 50 | 51 | 52 | 53 | &reftitle.seealso; 54 | 55 | &function.mysql_stmt_next_result; 56 | 57 | 58 | 59 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_stmt_num_rows.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_stmt_num_rows 5 | 6 | 7 | mysql_stmt_num_rows 8 | Returns the number of rows in a prepared statement result set 9 | 10 | 11 | &reftitle.description; 12 | 13 | my_ulonglong 14 | mysql_stmt_num_rows 15 | 16 | MYSQL_STMT * 17 | stmt 18 | 19 | 20 | 21 | Returns the number of rows in the result set. The use of 22 | &function.mysql_stmt_num_rows; depends on whether or not you used 23 | &function.mysql_stmt_store_result; to buffer the entire result set in the 24 | statement handle. 25 | 26 | 27 | 28 | &reftitle.parameters; 29 | 30 | 31 | 32 | stmt 33 | ¶m.stmt; 34 | 35 | 36 | 37 | 38 | 39 | &reftitle.retval; 40 | 41 | The number of rows in a result set of a prepared statement. 42 | 43 | 44 | 45 | &reftitle.notes; 46 | 47 | 48 | If you use &function.mysql_stmt_store_result;, 49 | &function.mysql_stmt_num_rows; may be called immediately. 50 | 51 | 52 | 53 | 54 | &reftitle.seealso; 55 | 56 | &function.mysql_stmt_store_result; 57 | 58 | 59 | 60 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_stmt_param_count.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_stmt_param_count 5 | 6 | 7 | mysql_stmt_param_count 8 | Returns the number of parameter for the given statement 9 | 10 | 11 | &reftitle.description; 12 | 13 | unsigned long 14 | mysql_stmt_param_count 15 | 16 | MYSQL_STMT * 17 | stmt 18 | 19 | 20 | 21 | Returns the number of parameter markers present in the prepared statement. 22 | 23 | 24 | 25 | &reftitle.parameters; 26 | 27 | 28 | 29 | stmt 30 | ¶m.stmt; 31 | 32 | 33 | 34 | 35 | 36 | &reftitle.retval; 37 | 38 | Returns the number of parameters in a prepared statement 39 | 40 | 41 | 42 | &reftitle.version; 43 | 44 | &product_name; 1.0 45 | 46 | 47 | 48 | &reftitle.notes; 49 | 50 | 51 | This function will not deliver a valid result until 52 | &function.mysql_stmt_prepare; was called. 53 | 54 | 55 | 56 | 57 | &reftitle.seealso; 58 | 59 | &function.mysql_stmt_prepare;, &function.mysql_stmt_field_count; 60 | 61 | 62 | 63 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_stmt_param_metadata.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_stmt_param_metadata 5 | 6 | 7 | mysql_stmt_param_metadata 8 | Returns metadata information for parameter markers 9 | 10 | 11 | &reftitle.description; 12 | 13 | MYSQL_RES * 14 | mysql_stmt_param_metadata 15 | 16 | MYSQL_STMT * 17 | stmt 18 | 19 | 20 | 21 | This functionality is currently not supported by MariaDB servers. 22 | 23 | 24 | 25 | &reftitle.parameters; 26 | 27 | 28 | 29 | stmt 30 | A handle for a prepared statement 31 | 32 | 33 | 34 | 35 | 36 | &reftitle.retval; 37 | 38 | NULL 39 | 40 | 41 | 42 | &reftitle.notes; 43 | 44 | 45 | The MariaDB server curremtly doesn't provide metadata information for parameter markers. In case the parameter type is not known, the bind 46 | buffer should be bound to a string (MYSQL_TYPE_STRING). 47 | 48 | 49 | 50 | 51 | &reftitle.seealso; 52 | 53 | 54 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_stmt_reset.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_stmt_reset 5 | 6 | 7 | mysql_stmt_reset 8 | Resets a prepared statement. 9 | 10 | 11 | &reftitle.description; 12 | 13 | my_bool 14 | mysql_stmt_reset 15 | 16 | MYSQL_STMT * 17 | stmt 18 | 19 | 20 | 21 | Resets a prepared statement on client and server to state after prepare. 22 | 23 | 24 | 25 | &reftitle.parameters; 26 | 27 | 28 | 29 | stmt 30 | ¶m.stmt; 31 | 32 | 33 | 34 | 35 | 36 | &reftitle.retval; 37 | 38 | &return.my_bool; 39 | 40 | 41 | 42 | &reftitle.notes; 43 | 44 | 45 | &function.mysql_stmt_reset; resets the statement on the server, unbuffered 46 | result sets and errors. Bindings and stored result sets will not be cleared. 47 | The latter one will be cleared when reexecuting or closing the prepared 48 | statement. 49 | 50 | 51 | To reprepare a prepared statement with another SQL statement use 52 | &function.mysql_stmt_prepare;. 53 | 54 | 55 | 56 | 57 | &reftitle.seealso; 58 | 59 | &function.mysql_stmt_close;, &function.mysql_stmt_prepare;, 60 | &function.mysql_stmt_execute; 61 | 62 | 63 | 64 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_stmt_row_seek.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_stmt_row_seek 5 | 6 | 7 | mysql_stmt_row_seek 8 | Positions row cursors 9 | 10 | 11 | &reftitle.description; 12 | 13 | MYSQL_ROW_OFFSET 14 | mysql_stmt_row_seek 15 | 16 | MYSQL_STMT * 17 | stmt 18 | 19 | 20 | MYSQL_ROW_OFFSET 21 | offset 22 | 23 | 24 | 25 | Positions the row cursor to an aribtrary row in a result set which was 26 | obtaimed by &function.mysql_stmt_store_result;. 27 | 28 | 29 | 30 | &reftitle.parameters; 31 | 32 | 33 | 34 | stmt 35 | ¶m.stmt; 36 | 37 | 38 | offset 39 | Row offset. This value can be obtained either by &function.mysql_stmt_row_seek; or &function.mysql_stmt_row_tell; 40 | 41 | 42 | 43 | 44 | 45 | &reftitle.retval; 46 | 47 | The previous row offset. 48 | 49 | 50 | 51 | &reftitle.notes; 52 | 53 | 54 | The result set must be obtained by &function.mysql_use_result;. 55 | 56 | 57 | 58 | 59 | &reftitle.seealso; 60 | 61 | &function.mysql_stmt_row_tell;, &function.mysql_stmt_store_result; 62 | 63 | 64 | 65 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_stmt_row_tell.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_stmt_row_tell 5 | 6 | 7 | mysql_stmt_row_tell 8 | Returns position of result cursor 9 | 10 | 11 | &reftitle.description; 12 | 13 | MYSQL_ROW_OFFSET 14 | mysql_stmt_row_tell 15 | 16 | MYSQL_STMT * 17 | stmt 18 | 19 | 20 | 21 | Returns the row offset of a result cursor. The returned offset value can be 22 | used to reposition the result cursor by calling 23 | &function.mysql_stmt_row_seek; 24 | 25 | 26 | 27 | &reftitle.parameters; 28 | 29 | 30 | 31 | stmt 32 | ¶m.stmt; 33 | 34 | 35 | 36 | 37 | 38 | &reftitle.retval; 39 | 40 | The row offset of the result cursor 41 | 42 | 43 | 44 | &reftitle.version; 45 | 46 | &product_name; 1.0 47 | 48 | 49 | 50 | &reftitle.notes; 51 | 52 | 53 | This function can be used for buffered result sets only, which can be 54 | obtained by executing &function.mysql_stmt_store_result; function. 55 | 56 | 57 | 58 | 59 | &reftitle.seealso; 60 | 61 | &function.mysql_stmt_row_seek;, &function.mysql_stmt_store_result; 62 | 63 | 64 | 65 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_stmt_sqlstate.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_stmt_sqlstate 5 | 6 | 7 | mysql_stmt_sqlstate 8 | returns SQLSTATE error from previous statement operation 9 | 10 | 11 | &reftitle.description; 12 | 13 | const char * 14 | mysql_stmt_sqlstate 15 | 16 | MYSQL_STMT * 17 | stmt 18 | 19 | 20 | 21 | Returns a string containing the SQLSTATE error code for the most recently 22 | invoked prepared statement function that can succeed or fail. The error code 23 | consists of five characters. '00000' means no error. The values are specified 24 | by ANSI SQL and ODBC. 25 | 26 | 27 | 28 | &reftitle.parameters; 29 | 30 | 31 | 32 | stmt 33 | ¶m.stmt; 34 | 35 | 36 | 37 | 38 | 39 | &reftitle.retval; 40 | 41 | Returns a string containing the SQLSTATE error code for the last error. The 42 | error code consists of five characters. ' 43 | 00000' 44 | means no error. 45 | 46 | 47 | 48 | &reftitle.notes; 49 | 50 | 51 | Please note that not all client library error codes are mapped to SQLSTATE 52 | errors. Errors which can't be mapped will returned as value 53 | HY000 54 | . 55 | 56 | 57 | 58 | 59 | &reftitle.seealso; 60 | 61 | &function.mysql_errno;, &function.mysql_error; 62 | 63 | 64 | 65 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_stmt_store_result.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_stmt_store_result 5 | 6 | 7 | mysql_stmt_store_result 8 | Transfers a result set from a prepared statement 9 | 10 | 11 | &reftitle.description; 12 | 13 | int 14 | mysql_stmt_store_result 15 | 16 | MYSQL_STMT * 17 | stmt 18 | 19 | 20 | 21 | You must call &function.mysql_stmt_store_result; for every query that 22 | successfully produces a result set ( 23 | SELECT, SHOW, DESCRIBE, EXPLAIN 24 | ), and only if you want to buffer the complete result set by the client, so 25 | that the subsequent &function.mysql_stmt_fetch; call returns buffered data. 26 | 27 | 28 | 29 | &reftitle.parameters; 30 | 31 | 32 | 33 | stmt 34 | ¶m.stmt; 35 | 36 | 37 | 38 | 39 | 40 | &reftitle.retval; 41 | 42 | &return.my_bool; 43 | 44 | 45 | 46 | &reftitle.notes; 47 | 48 | 49 | You can detect whether the statement produced a result set by checking the 50 | return value of &function.mysql_stmt_result_metadata; function. 51 | 52 | 53 | 54 | 55 | &reftitle.seealso; 56 | &function.mysql_stmt_result_metadata;, 57 | &function.mysql_stmt_fetch; 58 | 59 | 60 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_store_result.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_store_result 5 | 6 | 7 | mysql_store_result 8 | Returns a buffered resultset from the last executed query 9 | 10 | 11 | &reftitle.description; 12 | 13 | MYSQL_RES * 14 | mysql_store_result 15 | 16 | MYSQL * 17 | mysql 18 | 19 | 20 | 21 | Transfers a buffered result set from the last query on the database 22 | connection 23 | 24 | 25 | 26 | &reftitle.parameters; 27 | 28 | 29 | 30 | mysql 31 | ¶m.mysql; 32 | 33 | 34 | 35 | 36 | 37 | &reftitle.retval; 38 | 39 | A buffered result set or NULL if an error occured. 40 | 41 | 42 | 43 | &reftitle.notes; 44 | 45 | 46 | &function.mysql_store_result; returns NULL in case an error occured or if 47 | the query didn't return data (e.g. when executing an 48 | INSERT 49 | or 50 | UPDATE 51 | query. 52 | 53 | 54 | &function.mysql_field_count; indicates if there will be a result set 55 | available. 56 | 57 | 58 | The memory allocated by &function.mysql_store_result; needs to be relased by 59 | calling the function &function.mysql_free_result;. 60 | 61 | 62 | 63 | 64 | &reftitle.seealso; 65 | 66 | &function.mysql_use_result;, &function.mysql_real_query;, 67 | &function.mysql_field_count; 68 | 69 | 70 | 71 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_thread_end.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_thread_end 5 | 6 | 7 | mysql_thread_end 8 | release thread specific memory for multi threaded client application 9 | 10 | 11 | &reftitle.description; 12 | 13 | void 14 | mysql_thread_end 15 | 16 | void 17 | 18 | 19 | 20 | 21 | The &function.mysql_thread_end; function needs to be called before a client 22 | thread ends. It will release thread specific memory, which was allocated by a 23 | previous &function.mysql_thread_init; call. 24 | 25 | 26 | 27 | &reftitle.retval; 28 | 29 | void 30 | 31 | 32 | 33 | &reftitle.notes; 34 | 35 | 36 | Unlike &function.mysql_thread_init; &function.mysql_thread_end; will not be 37 | invoked automatically if the thread ends. To avoid memory leaks 38 | &function.mysql_thread_end; must be called explicitly. 39 | 40 | 41 | 42 | 43 | &reftitle.seealso; 44 | 45 | &function.mysql_thread_init;, &function.mysql_thread_safe; 46 | 47 | 48 | 49 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_thread_id.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_thread_id 5 | 6 | 7 | mysql_thread_id 8 | Returns the thread id for the current connection 9 | 10 | 11 | &reftitle.description; 12 | 13 | unsigned long 14 | mysql_thread_id 15 | 16 | MYSQL * 17 | mysql 18 | 19 | 20 | 21 | The &function.mysql_thread_id; function returns the thread id for the current 22 | connection. 23 | 24 | 25 | 26 | &reftitle.parameters; 27 | 28 | 29 | 30 | mysql 31 | ¶m.mysql; 32 | 33 | 34 | 35 | 36 | 37 | &reftitle.retval; 38 | 39 | The thread id for the current connection. 40 | 41 | 42 | 43 | &reftitle.notes; 44 | 45 | 46 | The current connection can be killed with &function.mysql_kill; 47 | 48 | 49 | If 50 | 51 | option is enabled the thread id might change if the client reconnects to the 52 | server. 53 | 54 | 55 | 56 | 57 | &reftitle.seealso; 58 | 59 | &function.mysql_kill;, &function.mysql_options; 60 | 61 | 62 | 63 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_thread_init.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_thread_init 5 | 6 | 7 | mysql_thread_init 8 | Thread initialization for multi threaded clients 9 | 10 | 11 | &reftitle.description; 12 | 13 | my_bool 14 | mysql_thread_init 15 | 16 | void 17 | 18 | 19 | 20 | 21 | Multi threaded clients should call &function.mysql_thread_init; at the 22 | beginning of the thread initialization to initialize thread specific client 23 | library variables. If &function.mysql_thread_init; was not called explicitly, 24 | it will be called automatically by &function.mysql_init; or 25 | &function.mysql_real_connect;. 26 | 27 | 28 | 29 | &reftitle.retval; 30 | 31 | Zero if successful or 1 if an error occured 32 | 33 | 34 | 35 | &reftitle.notes; 36 | 37 | 38 | Before a client thread ends the &function.mysql_thread_end; function must be 39 | called to release memory - otherwise the client library will report an 40 | error. 41 | 42 | 43 | 44 | 45 | &reftitle.seealso; 46 | 47 | &function.mysql_thread_end;, &function.mysql_thread_safe; 48 | 49 | 50 | 51 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_thread_safe.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_thread_safe 5 | 6 | 7 | mysql_thread_safe 8 | Returns whether thread safety is given or not 9 | 10 | 11 | &reftitle.description; 12 | 13 | unsigned int 14 | mysql_thread_safe 15 | 16 | void 17 | 18 | 19 | 20 | 21 | Tells whether the client library is compiled as thread safe. 22 | 23 | 24 | 25 | &reftitle.retval; 26 | 27 | 1 if the client library was compiled as thread safe otherwise zero 28 | 29 | 30 | 31 | &reftitle.notes; 32 | 33 | 34 | By default the mariadb client library is compiled as thread safe. 35 | 36 | 37 | 38 | 39 | &reftitle.seealso; 40 | 41 | &function.mysql_thread_init;, &function.mysql_thread_end; 42 | 43 | 44 | 45 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_use_result.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_use_result 5 | 6 | 7 | mysql_use_result 8 | Initiate an unbuffered result set retrieval 9 | 10 | 11 | &reftitle.description; 12 | 13 | MYSQL_RES * 14 | mysql_use_result 15 | 16 | MYSQL * 17 | mysql 18 | 19 | 20 | 21 | Used to initiate the retrieval of a result set from the last query executed 22 | using the &function.mysql_real_query; function on the database connection. 23 | Either this or the &function.mysql_store_result; function must be called 24 | before the results of a query can be retrieved, and one or the other must be 25 | called to prevent the next query on that database connection from failing. 26 | 27 | 28 | 29 | &reftitle.parameters; 30 | 31 | 32 | 33 | mysql 34 | ¶m.mysql; 35 | 36 | 37 | 38 | 39 | 40 | &reftitle.retval; 41 | 42 | Returns an unbuffered result set or NULL if an error occured. 43 | 44 | 45 | 46 | &reftitle.notes; 47 | 48 | 49 | The &function.mysql_use_result; function does not transfer the entire result 50 | set. Hence several functions like &function.mysql_num_rows; or 51 | &function.mysql_data_seek; cannot be used. 52 | 53 | 54 | &function.mysql_use_result; will block the current connection until all 55 | result sets are retrieved or result set was released 56 | by&function.mysql_free_result;. 57 | 58 | 59 | 60 | 61 | &reftitle.seealso; 62 | 63 | &function.mysql_store_result;, &function.mysql_free_result; 64 | 65 | 66 | 67 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/mysql_warning_count.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_warning_count 5 | 6 | 7 | mysql_warning_count 8 | Returns the number of warnings from the last executed query 9 | 10 | 11 | &reftitle.description; 12 | 13 | unsigned int 14 | mysql_warning_count 15 | 16 | MYSQL * 17 | mysql 18 | 19 | 20 | 21 | Returns the number of warnings from the last executed query 22 | 23 | 24 | 25 | &reftitle.parameters; 26 | 27 | 28 | 29 | mysql 30 | ¶m.mysql; 31 | 32 | 33 | 34 | 35 | 36 | &reftitle.retval; 37 | 38 | The number of warnings or zero if there are no warnings 39 | 40 | 41 | 42 | &reftitle.notes; 43 | 44 | 45 | For retrieving warning messages you should use the SQL command 46 | SHOW WARNINGS 47 | 48 | 49 | If sqlmode 50 | TRADITIONAL 51 | is enabled an error instead of warning will be returned. For detailed 52 | information check the server documentation. 53 | 54 | 55 | 56 | 57 | &reftitle.seealso; 58 | 59 | &function.mysql_stmt_affected_rows; 60 | 61 | 62 | 63 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/client_server/reference.xml: -------------------------------------------------------------------------------- 1 | 2 |
3 | 4 | Function reference 5 | 6 | 7 | Not all functions are supported by all packages. Please refer to the version 8 | information inside the function reference to check if the function is 9 | supported. Some functionality like experimental features are disabled by 10 | default and can be activated by build switches. 11 | 12 | 13 | The MariaDB client server API is compatible with the MySQL client library. 14 | The API was built on top of MySQL 3.23 and PHP's mysqlnd extension. Functions 15 | which support specific MariaDB server features are prefixed with mariadb 16 | instead of mysql. 17 | 18 | &api.client_server.entities.functions; 19 |
20 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/dyncol/book.xml: -------------------------------------------------------------------------------- 1 | 2 |
3 | 4 | Dynamic column API 5 | 6 | 7 | Dynamic columns allows one to store different sets of columns for each row in 8 | a table. It works by storing a set of columns in a blob and having a small set 9 | of functions to manipulate it. 10 | 11 | 12 | Dynamic columns should be used when it is not possible to use regular columns. 13 | 14 | 15 | A typical use case is when one needs to store items that may have many 16 | different attributes (like size, color, weight, etc), and the set of possible 17 | attributes is very large and/or unknown in advance. In that case, attributes 18 | can be put into dynamic columns. 19 | 20 | &reftitle.notes; 21 | 22 | &reftitle.notes; 23 | 24 | To use the dynamic column api you have to include the file 25 | ma_dyncol.h 26 | . 27 | 28 | 29 | 30 | &api.dyncol.data_structures; 31 | &api.dyncol.constants; 32 | &api.dyncol.reference; 33 |
34 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/dyncol/data_structures.xml: -------------------------------------------------------------------------------- 1 | 2 |
3 | &reftitle.data_structures; 4 | 5 | 6 | DYNAMIC_COLUMN 7 | 8 | &version_1_1; 9 | 10 | DYNAMIC_COLUMN 11 | DYNAMIC_COLUMN 12 | packed dynamic column blob 13 | 14 | 15 | DYNAMIC_COLUMN 16 | represents a packed dynamic column blob. It is essentially a 17 | string-with-length. 18 | 19 | 20 | DYNAMIC_COLUMN 21 | is defined in 22 | ma_dyncol.h 23 | 24 | 25 | 32 | 33 | 34 | 35 | 36 | DYNAMIC_COLUMN_VALUE 37 | 38 | &version_1_1; 39 | 40 | DYNAMIC_COLUMN_VALUE 41 | DYNAMIC_COLUMN_VALUE 42 | Dynamic columns blob stores for key/value pairs. 43 | 44 | 45 | DYNAMIC_COLUMN_VALUE 46 | stores key/value pairs. 47 | DYNAMIC_COLUMN_VALUE 48 | structure is used to represent the value in accessible form 49 | 50 | 51 | DYNAMIC_COLUMN 52 | is defined in 53 | ma_dyncol.h 54 | 55 | 56 | 77 | 78 | 79 |
80 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/dyncol/entities.functions.xml: -------------------------------------------------------------------------------- 1 | 4 | &api.dyncol.mariadb_dyncol_column_count; 5 | &api.dyncol.mariadb_dyncol_create_many_named; 6 | &api.dyncol.mariadb_dyncol_create_many_num; 7 | &api.dyncol.mariadb_dyncol_exists_named; 8 | &api.dyncol.mariadb_dyncol_exists_num; 9 | &api.dyncol.mariadb_dyncol_free; 10 | &api.dyncol.mariadb_dyncol_get_named; 11 | &api.dyncol.mariadb_dyncol_get_num; 12 | &api.dyncol.mariadb_dyncol_init; 13 | &api.dyncol.mariadb_dyncol_list_named; 14 | &api.dyncol.mariadb_dyncol_list_num; 15 | &api.dyncol.mariadb_dyncol_unpack; 16 | &api.dyncol.mariadb_dyncol_update_many_named; 17 | &api.dyncol.mariadb_dyncol_update_many_num; 18 | 19 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/dyncol/mariadb_dyncol_free.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mariadb_dyncol_free 5 | 6 | 7 | mariadb_dyncol_free 8 | Release memory associated by a dynamic column 9 | 10 | 11 | 12 | &reftitle.description; 13 | 14 | void 15 | mariadb_dyncol_column_free 16 | 17 | DYNAMIC_COLUMN * 18 | str 19 | 20 | 21 | 22 | Release memory associated by a dynamic column, which was previously allocated 23 | by &function.mariadb_dyncol_create_many_named; or 24 | &function.mariadb_dyncol_create_many_num; 25 | 26 | 27 | 28 | &reftitle.parameters; 29 | 30 | 31 | 32 | 33 | str 34 | 35 | A pointer to a dynamic column. 36 | 37 | 38 | 39 | 40 | 41 | &reftitle.retval; 42 | 43 | Returns 0 or positive value on success, a nagative value on error. 44 | 45 | 46 | 47 | &reftitle.notes; 48 | 49 | &reftitle.notes; 50 | 51 | 52 | 53 | &reftitle.seealso; 54 | 55 | &function.mariadb_dyncol_create_many_named; 56 | 57 | 58 | 59 | 60 | Example 61 | 62 | 63 | 64 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/dyncol/reference.xml: -------------------------------------------------------------------------------- 1 | 2 |
3 | 4 | Function reference 5 | 6 | 7 | &reftitle.notes; 8 | 9 | &reftitle.notes; 10 | 11 | The dynamic column API from MariaDB 5.5 is deprecated and not supported 12 | anymore. 13 | 14 | 15 | To migrate your code, please change the 16 | dynamic_column_xxxx 17 | function calls to 18 | mariadb_dyncol_xxxxx_num 19 | syntax. 20 | 21 | 22 | 23 | &api.dyncol.entities.functions; 24 |
25 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/nonblock/entities.functions.xml: -------------------------------------------------------------------------------- 1 | 4 | &api.nonblock.mysql_get_socket; 5 | &api.nonblock.mysql_get_timeout_value; 6 | &api.nonblock.mysql_get_timeout_value_ms; 7 | &api.nonblock.mysql_real_connect_start; 8 | &api.nonblock.mysql_real_connect_cont; 9 | &api.nonblock.mysql_real_query_start; 10 | &api.nonblock.mysql_real_query_cont; 11 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/nonblock/mysql_get_socket.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_get_socket 5 | 6 | 7 | mysql_get_socket 8 | Returns the descriptor of the socket used for the connection 9 | 10 | 11 | &reftitle.description; 12 | 13 | my_socket 14 | mysql_get_socket 15 | 16 | const MYSQL * 17 | mysql 18 | 19 | 20 | 21 | Returns the descriptor of the socket used for the connection. 22 | The descriptor of the socket can be used for poll() as shown 23 | in the example at the beginning of the non-blocking API chapter. 24 | 25 | 26 | 27 | &reftitle.parameters; 28 | 29 | 30 | 31 | mysql 32 | ¶m.mysql; 33 | 34 | 35 | 36 | 37 | 38 | &reftitle.retval; 39 | 40 | Returns the descriptor of the socket used for the current connection or MARIADB_INVALID_SOCKET if an error occured. 41 | 42 | 43 | 44 | &reftitle.version; 45 | &product_name; 2.0 46 | 47 | 48 | &reftitle.seealso; 49 | 50 | &function.mysql_get_timeout_value; &function.mysql_get_timeout_value_ms; 51 | 52 | 53 | 54 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/nonblock/mysql_get_timeout_value.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | mysql_get_timeout_value 5 | 6 | 7 | mysql_get_timeout_values 8 | Returns the value for read time out in seconds. 9 | 10 | 11 | &reftitle.description; 12 | 13 | unsigned int 14 | mysql_get_timeout_value 15 | 16 | MYSQL * 17 | mysql 18 | 19 | 20 | 21 | Returns the value for read time out in seconds. 22 | 23 | 24 | 25 | &reftitle.parameters; 26 | 27 | 28 | 29 | mysql 30 | ¶m.mysql; 31 | 32 | 33 | 34 | 35 | 36 | &reftitle.retval; 37 | 38 | Returns the read time out value in seconds. 39 | 40 | 41 | 42 | &reftitle.version; 43 | &product_name; 2.0 44 | 45 | 46 | &reftitle.notes; 47 | 48 | 49 | 50 | This should only be called when a _start() or _cont() function returns a value with the MYSQL_WAIT_TIMEOUT flag set. In this case, it returns the value, in seconds, after which a timeout has occured and the application should call the appropriate _cont() function passing MYSQL_WAIT_TIMEOUT as the event that occured. 51 | 52 | 53 | 54 | 55 | 56 | &reftitle.seealso; 57 | 58 | &function.mysql_get_socket; &function.mysql_get_timeout_value_ms; 59 | 60 | 61 | 62 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/nonblock/reference.xml: -------------------------------------------------------------------------------- 1 | 2 |
3 | 4 | Function reference 5 | 6 | 7 | Here is a list of all functions in the non-blocking client API and their parameters. Apart from operating in a non-blocking way, they all work exactly the same as their non-blocking counterparts, so their exact semantics can be obtained from the documentation of the normal client API. 8 | 9 | 10 | Not all functions are supported by all packages. Please refer to the version 11 | information inside the function reference to check if the function is 12 | supported. Some functionality like experimental features are disabled by 13 | default and can be activated by build switches. 14 | 15 | &api.nonblock.entities.functions; 16 |
17 | -------------------------------------------------------------------------------- /webhelp/docsrc/api/nonblock/tags: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/docsrc/api/nonblock/tags -------------------------------------------------------------------------------- /webhelp/docsrc/api/x.x: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/docsrc/api/x.x -------------------------------------------------------------------------------- /webhelp/docsrc/appendices/changelog.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Revision history 5 | 6 | &revhistory.log; 7 | 8 | -------------------------------------------------------------------------------- /webhelp/docsrc/chapters/introduction.xml: -------------------------------------------------------------------------------- 1 | 2 |
3 | 4 | The MariaDB client library (also known as libmariadb) is the C application 5 | programmers interface to MariaDB. It contains a collection of functions that 6 | allow client programs to send statements to the MariaDB server and to receive 7 | data of these statements. 8 | 9 | 10 | The MariaDB client library is licensed under the LGPL License Version 2. It's 11 | derived from the MySQL 3.23.58 client library and PHP's mysqlnd extension. It 12 | is fully binary compatible to MySQL client library, so it's possible to 13 | communicate with database servers from other vendors. Since the MariaDB server 14 | offers more functionality not all functions might be supported by databases 15 | from other vendors. 16 | 17 | 18 | It can be also used as an underlying layer for other application and programm 19 | interfaces like PHP, Perl, Python and others. 20 | 21 | 26 |
27 | -------------------------------------------------------------------------------- /webhelp/docsrc/entities/default-defs.ent: -------------------------------------------------------------------------------- 1 | 4 | Notes"> 5 | Constants"> 6 | Data structure"> 7 | Description"> 8 | Parameters"> 9 | Version"> 10 | Return value"> 11 | See also"> 12 | Example"> 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /webhelp/docsrc/entities/file.ent.in: -------------------------------------------------------------------------------- 1 | 4 | @file_entities@ 5 | -------------------------------------------------------------------------------- /webhelp/docsrc/entities/funcref.ent.in: -------------------------------------------------------------------------------- 1 | 4 | @function_entities@ 5 | 6 | 7 | -------------------------------------------------------------------------------- /webhelp/docsrc/entities/functions.ent.in: -------------------------------------------------------------------------------- 1 | 4 | @function_entities@ 5 | -------------------------------------------------------------------------------- /webhelp/docsrc/entities/var.ent.in: -------------------------------------------------------------------------------- 1 | 4 | 5 | 6 | 7 | 8 | -------------------------------------------------------------------------------- /webhelp/docsrc/examples/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | FILE(GLOB EXAMPLE_FILES ${CMAKE_CURRENT_DIR} *.c) 2 | 3 | # GET MARIADB_CLIENT_DIR 4 | IF(NOT MARIADB_CLIENT_DIR) 5 | MESSAGE(FATAÖ "MariaDB client directory not specified (-DMARIADB_CLIENT_DIR=/path/to/mariadb_client)") 6 | ENDIF() 7 | 8 | EXEC_PROGRAM(${MARIADB_CLIENT_DIR}/bin/mariadb_config ${MARIADB_CLIENT_DIR}/bin 9 | ARGS --libs 10 | OUTPUT_VARIABLE mariadb_libs 11 | RETURN_VARIABLE ret) 12 | EXEC_PROGRAM(${MARIADB_CLIENT_DIR}/bin/mariadb_config ${MARIADB_CLIENT_DIR}/bin 13 | ARGS --include 14 | OUTPUT_VARIABLE mariadb_include 15 | RETURN_VARIABLE ret) 16 | 17 | LIST(APPEND EXCLUDE_FROM_OUTPUT "mysql_debug1") 18 | 19 | SET(CMAKE_C_FLAGS ${CMAKE_C_FLAGS} ${mariadb_include}) 20 | ADD_DEFINITIONS(-DTHREAD) 21 | 22 | FOREACH(EXAMPLE_FILE ${EXAMPLE_FILES}) 23 | GET_FILENAME_COMPONENT(EXAMPLE_FILE ${EXAMPLE_FILE} NAME) 24 | STRING(REPLACE ".c" "" EXAMPLE_FILE ${EXAMPLE_FILE}) 25 | MESSAGE(STATUS "${EXAMPLE_FILE}") 26 | ADD_EXECUTABLE(${EXAMPLE_FILE} ${EXAMPLE_FILE}.c) 27 | TARGET_LINK_LIBRARIES(${EXAMPLE_FILE} ${mariadb_libs}) 28 | LIST(FIND EXCLUDE_FROM_OUTPUT ${EXAMPLE_FILE} result) 29 | IF(result EQUAL -1) 30 | ADD_CUSTOM_COMMAND(OUTPUT ${EXAMPLE_FILE}.out 31 | COMMAND ${EXAMPLE_FILE} 32 | ARGS > ${EXAMPLE_FILE}.out 33 | WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/examples 34 | DEPENDS ${EXAMPLE_FILE}) 35 | SET(example_list ${example_list} ${EXAMPLE_FILE}.out ${EXAMPLE_FILE}) 36 | ENDIF() 37 | ENDFOREACH() 38 | ADD_CUSTOM_TARGET(EXAMPLE_FILE_OUTPUT ALL DEPENDS ${example_list}) 39 | 40 | -------------------------------------------------------------------------------- /webhelp/docsrc/examples/mariadb_dyncol_list_named.c: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | #include 5 | #include 6 | 7 | int main(int argc, char *argv[]) 8 | { 9 | DYNAMIC_COLUMN dyncol; 10 | MYSQL_LEX_STRING *list_keys, my_keys[]= {{"key1", 4}, {"key2",4}, {"key3", 4}}; 11 | char *my_vals[]= {"value1", "value2", "value3"}; 12 | DYNAMIC_COLUMN_VALUE *vals; 13 | unsigned int i, column_count; 14 | CHARSET_INFO *cs= mysql_get_charset_by_name("utf8"); 15 | 16 | mariadb_dyncol_init(&dyncol); 17 | 18 | vals= (DYNAMIC_COLUMN_VALUE *)malloc(sizeof(DYNAMIC_COLUMN_VALUE) * 3); 19 | for (i=0; i < 3; i++) 20 | { 21 | vals[i].type= DYN_COL_STRING; 22 | vals[i].x.string.value.length= strlen(my_vals[i]); 23 | vals[i].x.string.value.str= my_vals[i]; 24 | vals[i].x.string.charset= cs; 25 | } 26 | /* Add columns */ 27 | if (mariadb_dyncol_create_many_named(&dyncol, 3, my_keys, vals, 0) != ER_DYNCOL_OK) 28 | { 29 | printf("Can't add columns\n"); 30 | exit(-1); 31 | } 32 | 33 | if (mariadb_dyncol_list_named(&dyncol, &column_count, &list_keys) == ER_DYNCOL_OK) 34 | { 35 | for (i=0; i < column_count; i++) 36 | printf("Column: %u Key: %s\n", i, list_keys[i].str); 37 | /* Don't forget to free the keys! */ 38 | free(list_keys); 39 | } 40 | mariadb_dyncol_free(&dyncol); 41 | 42 | return 0; 43 | } 44 | -------------------------------------------------------------------------------- /webhelp/docsrc/examples/mariadb_dyncol_list_num.c: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | #include 5 | #include 6 | #include 7 | 8 | int main(int argc, char *argv[]) 9 | { 10 | DYNAMIC_COLUMN dyncol; 11 | unsigned int *list_keys, my_keys[]= {1, 4, 7}; 12 | char *my_vals[]= {"value1", "value2", "value3"}; 13 | DYNAMIC_COLUMN_VALUE *vals; 14 | unsigned int i, column_count; 15 | CHARSET_INFO *cs= mysql_get_charset_by_name("utf8"); 16 | 17 | mariadb_dyncol_init(&dyncol); 18 | 19 | vals= (DYNAMIC_COLUMN_VALUE *)malloc(sizeof(DYNAMIC_COLUMN_VALUE) * 3); 20 | for (i=0; i < 3; i++) 21 | { 22 | vals[i].type= DYN_COL_STRING; 23 | vals[i].x.string.value.length= strlen(my_vals[i]); 24 | vals[i].x.string.value.str= my_vals[i]; 25 | vals[i].x.string.charset= cs; 26 | } 27 | /* Add columns */ 28 | if (mariadb_dyncol_create_many_num(&dyncol, 3, my_keys, vals, 0) != ER_DYNCOL_OK) 29 | { 30 | printf("Can't add columns\n"); 31 | exit(-1); 32 | } 33 | 34 | if (mariadb_dyncol_list_num(&dyncol, &column_count, &list_keys) == ER_DYNCOL_OK) 35 | { 36 | for (i=0; i < column_count; i++) 37 | printf("Column: %u Key: %u\n", i, list_keys[i]); 38 | /* Don't forget to free the keys! */ 39 | free(list_keys); 40 | } 41 | mariadb_dyncol_free(&dyncol); 42 | return 0; 43 | } 44 | -------------------------------------------------------------------------------- /webhelp/docsrc/examples/mysql_change_user.c: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | #include 5 | 6 | int main(int argc, char *argv[]) 7 | { 8 | MYSQL *mysql; 9 | MYSQL_RES *result; 10 | 11 | mysql= mysql_init(NULL); 12 | 13 | mysql_real_connect(mysql, "localhost", "root", NULL, 14 | "example_db", 0, NULL, 0); 15 | 16 | /************************************************** 17 | This example will not work if example user has not 18 | enough privileges to create a new user/role. 19 | **************************************************/ 20 | if (mysql_query(mysql, "GRANT ALL ON example_db.* TO 'testuser'@'localhost'" 21 | " IDENTIFIED by 'testpassword'")) 22 | { 23 | printf("Error (%d): %s\n", mysql_errno(mysql), mysql_error(mysql)); 24 | mysql_close(mysql); 25 | return 1; 26 | } 27 | 28 | mysql_autocommit(mysql, 0); 29 | 30 | mysql_query(mysql, "DROP TABLE IF EXISTS t1"); 31 | mysql_query(mysql, "CREATE TABLE t1 (id int, surname varchar(25)) ENGINE=InnoDB"); 32 | 33 | mysql_query(mysql, "INSERT INTO t1 VALUES (9, 'Henrik')"); 34 | 35 | /* change default database */ 36 | mysql_select_db(mysql, "test"); 37 | 38 | /************************************************** 39 | now we change the user for the current connection 40 | and check if the last statement was rolled back 41 | **************************************************/ 42 | mysql_change_user(mysql, "testuser", "testpassword", "example_db"); 43 | 44 | mysql_query(mysql, "SELECT id, surname FROM t1"); 45 | if ((result= mysql_store_result(mysql))) 46 | { 47 | printf("Expected 0 rows, got %u rows\n", mysql_num_rows(result)); 48 | mysql_free_result(result); 49 | } 50 | 51 | /* make sure that we are connected as another user 52 | to another database */ 53 | mysql_query(mysql, "SELECT CURRENT_USER(), DATABASE()"); 54 | if ((result= mysql_store_result(mysql))) 55 | { 56 | MYSQL_ROW row= mysql_fetch_row(result); 57 | if (row) 58 | printf("User %s is now connected to database %s\n", row[0], row[1]); 59 | mysql_free_result(result); 60 | } 61 | 62 | mysql_close(mysql); 63 | return 0; 64 | } 65 | -------------------------------------------------------------------------------- /webhelp/docsrc/examples/mysql_character_set_name.c: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | #include 5 | 6 | int main(int argc, char *argv[]) 7 | { 8 | MYSQL *mysql; 9 | MYSQL_RES *result; 10 | 11 | mysql= mysql_init(NULL); 12 | 13 | mysql_real_connect(mysql, "localhost", "example", "example_pw", 14 | "example_db", 0, NULL, 0); 15 | 16 | printf("Current character set: %s\n", 17 | mysql_character_set_name(mysql)); 18 | 19 | 20 | mysql_set_character_set(mysql, "latin2"); 21 | printf("New character set: %s\n", 22 | mysql_character_set_name(mysql)); 23 | 24 | mysql_close(mysql); 25 | return 0; 26 | } 27 | -------------------------------------------------------------------------------- /webhelp/docsrc/examples/mysql_commit.c: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | #include 5 | 6 | int main(int argc, char *argv[]) 7 | { 8 | MYSQL *mysql1, *mysql2; 9 | MYSQL_RES *result; 10 | char *query; 11 | 12 | /*Open two connetions with the same user */ 13 | 14 | mysql1= mysql_init(NULL); 15 | mysql2= mysql_init(NULL); 16 | 17 | 18 | mysql_real_connect(mysql1, "localhost", "example", "example_pw", 19 | "example_db", 0, NULL, 0); 20 | mysql_real_connect(mysql2, "localhost", "example", "example_pw", 21 | "example_db", 0, NULL, 0); 22 | 23 | mysql_query(mysql1, "DROP TABLE IF EXISTS commit_exanple"); 24 | 25 | /* This example will only work with transactional storage engines */ 26 | mysql_query(mysql1, "CREATE TABLE commit_example(a int) ENGINE=InnoDB"); 27 | 28 | /************************************************** 29 | Disable autocommit mode, insert two rows and 30 | check the number of rows in a second connection 31 | before and after commit 32 | **************************************************/ 33 | mysql_autocommit(mysql1, 0); 34 | mysql_query(mysql1, "INSERT INTO commit_example VALUES (1),(2)"); 35 | 36 | mysql_query(mysql2, "SELECT a FROM commit_example"); 37 | if ((result= mysql_store_result(mysql2))) 38 | { 39 | printf("Expected 0 rows, found %d rows\n", mysql_num_rows(result)); 40 | mysql_free_result(result); 41 | } 42 | 43 | /* now commit and check number of rows from 2nd connection */ 44 | mysql_commit(mysql1); 45 | mysql_query(mysql2, "SELECT a FROM commit_example"); 46 | if ((result= mysql_store_result(mysql2))) 47 | { 48 | printf("Expected 2 rows, found %d rows\n", mysql_num_rows(result)); 49 | mysql_free_result(result); 50 | } 51 | 52 | mysql_close(mysql1); 53 | mysql_close(mysql2); 54 | return 0; 55 | } 56 | -------------------------------------------------------------------------------- /webhelp/docsrc/examples/mysql_data_seek.c: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | #include 5 | 6 | int main(int argc, char *argv[]) 7 | { 8 | MYSQL *mysql; 9 | MYSQL_RES *result; 10 | MYSQL_ROW row; 11 | 12 | /*Open two connetions with the same user */ 13 | 14 | mysql= mysql_init(NULL); 15 | 16 | mysql_real_connect(mysql, "localhost", "example", "example_pw", 17 | "example_db", 0, NULL, 0); 18 | 19 | mysql_query(mysql, "DROP TABLE IF EXISTS data_seek"); 20 | mysql_query(mysql, "CREATE TABLE data_seek(id int not null primary key, " 21 | "surname char(50))"); 22 | 23 | mysql_query(mysql, "INSERT INTO data_seek VALUES (1, 'Rupert')," 24 | "(2, 'Hans'), (3, 'Willi'), (4, 'Archibald')"); 25 | 26 | mysql_query(mysql, "SELECT id, surname FROM data_seek ORDER BY id"); 27 | 28 | if ((result= mysql_store_result(mysql))) 29 | { 30 | /* seek to the 3rd row */ 31 | mysql_data_seek(result, 2); 32 | if ((row= mysql_fetch_row(result))) 33 | printf("Id: %s Surname: %s\n", row[0], row[1]); 34 | mysql_free_result(result); 35 | } 36 | mysql_close(mysql); 37 | } 38 | -------------------------------------------------------------------------------- /webhelp/docsrc/examples/mysql_debug.c: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | #include 5 | 6 | void show_error(MYSQL *mysql) 7 | { 8 | printf("Error(%d) [%s] \"%s\"", mysql_errno(mysql), 9 | mysql_sqlstate(mysql), 10 | mysql_error(mysql)); 11 | mysql_close(mysql); 12 | exit(-1); 13 | } 14 | 15 | int main(int argc, char *argv[]) 16 | { 17 | MYSQL *mysql; 18 | const char *query; 19 | 20 | mysql_debug("d:t:O,./mysql_debug.out"); 21 | 22 | mysql= mysql_init(NULL); 23 | 24 | if (!mysql_real_connect(mysql, "localhost", "example", "example_pw", 25 | "example_db", 0, NULL, 0)) 26 | show_error(mysql); 27 | 28 | query= "DROP TABLE IF EXISTS debug_example"; 29 | if (mysql_real_query(mysql, query, strlen(query))) 30 | show_error(mysql); 31 | 32 | query= "CREATE TABLE debug_example (id int not null, my_name varchar(50)," 33 | "PRIMARY KEY(id))"; 34 | if (mysql_real_query(mysql, query, strlen(query))) 35 | show_error(mysql); 36 | 37 | mysql_close(mysql); 38 | 39 | return 0; 40 | } 41 | -------------------------------------------------------------------------------- /webhelp/docsrc/examples/mysql_errno.c: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | #include 5 | 6 | int main(int argc, char *argv[]) 7 | { 8 | MYSQL *mysql; 9 | MYSQL_RES *result; 10 | MYSQL_ROW row; 11 | 12 | /*Open two connetions with the same user */ 13 | 14 | mysql= mysql_init(NULL); 15 | 16 | mysql_real_connect(mysql, "localhost", "example", "example_pw", 17 | "example_db", 0, NULL, 0); 18 | 19 | /* this error comes from the client library */ 20 | if (mysql_set_character_set(mysql, "utf19")) 21 | printf("Error: %u\n", mysql_errno(mysql)); 22 | 23 | /* this error comes from the server */ 24 | if (mysql_query(mysql, "SELECT anycolumn FROM anonexisting_table")) 25 | printf("Error: %u\n", mysql_errno(mysql)); 26 | 27 | mysql_close(mysql); 28 | } 29 | -------------------------------------------------------------------------------- /webhelp/docsrc/examples/mysql_error.c: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | #include 5 | 6 | int main(int argc, char *argv[]) 7 | { 8 | MYSQL *mysql; 9 | MYSQL_RES *result; 10 | MYSQL_ROW row; 11 | 12 | /*Open two connetions with the same user */ 13 | 14 | mysql= mysql_init(NULL); 15 | 16 | mysql_real_connect(mysql, "localhost", "example", "example_pw", 17 | "example_db", 0, NULL, 0); 18 | 19 | /* this error comes from the client library */ 20 | if (mysql_set_character_set(mysql, "utf19")) 21 | printf("Error: %s\n", mysql_error(mysql)); 22 | 23 | /* this error comes from the server */ 24 | if (mysql_query(mysql, "SELECT anycolumn FROM anonexisting_table")) 25 | printf("Error: %s\n", mysql_error(mysql)); 26 | 27 | mysql_close(mysql); 28 | } 29 | -------------------------------------------------------------------------------- /webhelp/docsrc/examples/mysql_real_connect_start.c: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | #include 5 | 6 | void show_error(MYSQL *mysql) 7 | { 8 | printf("Error(%d) [%s] \"%s\"", mysql_errno(mysql), 9 | mysql_sqlstate(mysql), 10 | mysql_error(mysql)); 11 | mysql_close(mysql); 12 | exit(-1); 13 | } 14 | 15 | int main(int argc, char *argv[]) 16 | { 17 | MYSQL *mysql, *retval; 18 | int status; 19 | 20 | mysql= mysql_init(NULL); 21 | mysql_options(mysql, MYSQL_OPT_NONBLOCK, 0); 22 | 23 | status= mysql_real_connect_s(&retval, mysql, "localhost", "example", "example_pw", 24 | "example_db", 0, NULL, 0)) 25 | 26 | if (status) 27 | printf("connect in progress "); 28 | 29 | while (status) 30 | { 31 | printf("."); 32 | status= mysql_real_connect_cont(&ret, mysql, status); 33 | } 34 | 35 | /* check the value of ret */ 36 | if (!ret) 37 | show_error(mysql); 38 | 39 | printf("done!\n"); 40 | 41 | mysql_close(mysql); 42 | return 0; 43 | } 44 | -------------------------------------------------------------------------------- /webhelp/docsrc/examples/nonblock_1.c: -------------------------------------------------------------------------------- 1 | static void run_query(const char *host, const char *user, const char *password) { 2 | int err, status; 3 | MYSQL mysql, *ret; 4 | MYSQL_RES *res; 5 | MYSQL_ROW row; 6 | 7 | mysql_init(&mysql); 8 | mysql_options(&mysql, MYSQL_OPT_NONBLOCK, 0); 9 | 10 | status = mysql_real_connect_start(&ret, &mysql, host, user, password, NULL, 0, NULL, 0); 11 | while (status) { 12 | status = wait_for_mysql(&mysql, status); 13 | status = mysql_real_connect_cont(&ret, &mysql, status); 14 | } 15 | 16 | if (!ret) 17 | fatal(&mysql, "Failed to mysql_real_connect()"); 18 | 19 | status = mysql_real_query_start(&err, &mysql, SL("SHOW STATUS")); 20 | while (status) { 21 | status = wait_for_mysql(&mysql, status); 22 | status = mysql_real_query_cont(&err, &mysql, status); 23 | } 24 | if (err) 25 | fatal(&mysql, "mysql_real_query() returns error"); 26 | 27 | /* This method cannot block. */ 28 | res= mysql_use_result(&mysql); 29 | if (!res) 30 | fatal(&mysql, "mysql_use_result() returns error"); 31 | 32 | for (;;) { 33 | status= mysql_fetch_row_start(&row, res); 34 | while (status) { 35 | status= wait_for_mysql(&mysql, status); 36 | status= mysql_fetch_row_cont(&row, res, status); 37 | } 38 | if (!row) 39 | break; 40 | printf("%s: %s\n", row[0], row[1]); 41 | } 42 | if (mysql_errno(&mysql)) 43 | fatal(&mysql, "Got error while retrieving rows"); 44 | mysql_free_result(res); 45 | mysql_close(&mysql); 46 | } 47 | 48 | /* Helper function to do the waiting for events on the socket. */ 49 | static int wait_for_mysql(MYSQL *mysql, int status) { 50 | struct pollfd pfd; 51 | int timeout, res; 52 | 53 | pfd.fd = mysql_get_socket(mysql); 54 | pfd.events = 55 | (status & MYSQL_WAIT_READ ? POLLIN : 0) | 56 | (status & MYSQL_WAIT_WRITE ? POLLOUT : 0) | 57 | (status & MYSQL_WAIT_EXCEPT ? POLLPRI : 0); 58 | if (status & MYSQL_WAIT_TIMEOUT) 59 | timeout = 1000*mysql_get_timeout_value(mysql); 60 | else 61 | timeout = -1; 62 | res = poll(&pfd, 1, timeout); 63 | if (res == 0) 64 | return MYSQL_WAIT_TIMEOUT; 65 | else if (res < 0) 66 | return MYSQL_WAIT_TIMEOUT; 67 | else { 68 | int status = 0; 69 | if (pfd.revents & POLLIN) status |= MYSQL_WAIT_READ; 70 | if (pfd.revents & POLLOUT) status |= MYSQL_WAIT_WRITE; 71 | if (pfd.revents & POLLPRI) status |= MYSQL_WAIT_EXCEPT; 72 | return status; 73 | } 74 | } 75 | -------------------------------------------------------------------------------- /webhelp/docsrc/global.ent: -------------------------------------------------------------------------------- 1 | 2 | 3 | mysql_store_result() or mysql_use_result()."> 4 | mysql_init() and connected by mysql_real_connect().'> 5 | mysql_store_result()."> 6 | mysql_stmt_init()."> 7 | 8 | 9 | Returns zero when done, or a bitmask of events it needs to wait on. This can be MYSQL_WAIT_READ, MYSQL_WAIT_WRITE, or MYSQL_WAIT_EXCEPT, corresponding to the similar flags for select() or poll() and it can include MYSQL_WAIT_TIMEOUT when waiting for a timeout to occur (e.g. a connection timeout)."> 10 | 11 | 12 | -------------------------------------------------------------------------------- /webhelp/docsrc/images/v_1_0.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/docsrc/images/v_1_0.png -------------------------------------------------------------------------------- /webhelp/docsrc/images/v_1_1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/docsrc/images/v_1_1.png -------------------------------------------------------------------------------- /webhelp/docsrc/images/v_2_0..png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/docsrc/images/v_2_0..png -------------------------------------------------------------------------------- /webhelp/docsrc/main.docbook: -------------------------------------------------------------------------------- 1 | 2 | 5 | 6 | 7 | 8 | 9 | %global_ents; 10 | %url_ents; 11 | %var_ents; 12 | %file_ents; 13 | %funcref_ents; 14 | 15 | %default_ents; 16 | ]> 17 | 18 | &product_name; 19 | &bookinfo; 20 | &preface; 21 | &chapters.introduction; 22 | &chapters.installation; 23 | 24 | API 25 | &api.charset.book; 26 | &api.client_server.book; 27 | &api.dyncol.book; 28 | &api.nonblock.book; 29 | 30 | 31 | Appendices 32 | &appendices.license; 33 | &appendices.quanda; 34 | &appendices.changelog; 35 | 36 | 37 | -------------------------------------------------------------------------------- /webhelp/docsrc/scripts/add_funcref.php: -------------------------------------------------------------------------------- 1 | $dir) { 20 | if (!$dir->isDir() && strpos($path, ".xml") > 0) { 21 | /* 22 | $entities .= sprintf("\n", 23 | str_replace(".xml", "", basename($path)), 24 | getcwd(), 25 | pathinfo($path, PATHINFO_DIRNAME), 26 | pathinfo($path, PATHINFO_BASENAME)); 27 | */ 28 | $entities .= sprintf("%s\">\n", 29 | str_replace(".xml", "", basename($path)), 30 | str_replace(".xml", "", basename($path)), 31 | str_replace(".xml", "", basename($path))); 32 | } 33 | } 34 | 35 | 36 | print($entities); 37 | ?> 38 | -------------------------------------------------------------------------------- /webhelp/docsrc/url.ent: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | www.mariadb.com/downloads'> 7 | www.cmake.org'> 8 | http://slproweb.com/products/Win32OpenSSL.html'> 9 | http://gnuwin32.sourceforge.net/packages/zlib.htm'> 10 | https://launchpad.net/bzr/+download'> 11 | http://wixtoolset.org/'> 12 | https://mariadb.atlassian.net/'> 13 | -------------------------------------------------------------------------------- /webhelp/docsrc/xsl/mariadb.xsl: -------------------------------------------------------------------------------- 1 | 2 | 4 | 5 | 6 | 7 | 8 | saxon:xhtml 9 | xml 10 | 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /webhelp/template/common/css/ie.css: -------------------------------------------------------------------------------- 1 | .statustext{ 2 | filter: progid:DXImageTransform.Microsoft.BasicImage(rotation=1) 3 | progid:DXImageTransform.Microsoft.BasicImage(opacity=.5); 4 | width: 100%; 5 | height: 30px; 6 | right: -5px; 7 | top:105px; 8 | /* left: 280px; */ /* change to -12px; when sidebar is collapsed */ 9 | } 10 | 11 | body #content{ 12 | /* padding-top: 136px;*/ 13 | } 14 | -------------------------------------------------------------------------------- /webhelp/template/common/images/callouts/1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/callouts/1.png -------------------------------------------------------------------------------- /webhelp/template/common/images/callouts/10.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/callouts/10.png -------------------------------------------------------------------------------- /webhelp/template/common/images/callouts/11.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/callouts/11.png -------------------------------------------------------------------------------- /webhelp/template/common/images/callouts/12.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/callouts/12.png -------------------------------------------------------------------------------- /webhelp/template/common/images/callouts/13.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/callouts/13.png -------------------------------------------------------------------------------- /webhelp/template/common/images/callouts/14.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/callouts/14.png -------------------------------------------------------------------------------- /webhelp/template/common/images/callouts/15.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/callouts/15.png -------------------------------------------------------------------------------- /webhelp/template/common/images/callouts/16.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/callouts/16.png -------------------------------------------------------------------------------- /webhelp/template/common/images/callouts/17.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/callouts/17.png -------------------------------------------------------------------------------- /webhelp/template/common/images/callouts/18.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/callouts/18.png -------------------------------------------------------------------------------- /webhelp/template/common/images/callouts/19.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/callouts/19.png -------------------------------------------------------------------------------- /webhelp/template/common/images/callouts/2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/callouts/2.png -------------------------------------------------------------------------------- /webhelp/template/common/images/callouts/20.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/callouts/20.png -------------------------------------------------------------------------------- /webhelp/template/common/images/callouts/21.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/callouts/21.png -------------------------------------------------------------------------------- /webhelp/template/common/images/callouts/22.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/callouts/22.png -------------------------------------------------------------------------------- /webhelp/template/common/images/callouts/23.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/callouts/23.png -------------------------------------------------------------------------------- /webhelp/template/common/images/callouts/24.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/callouts/24.png -------------------------------------------------------------------------------- /webhelp/template/common/images/callouts/25.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/callouts/25.png -------------------------------------------------------------------------------- /webhelp/template/common/images/callouts/26.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/callouts/26.png -------------------------------------------------------------------------------- /webhelp/template/common/images/callouts/27.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/callouts/27.png -------------------------------------------------------------------------------- /webhelp/template/common/images/callouts/28.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/callouts/28.png -------------------------------------------------------------------------------- /webhelp/template/common/images/callouts/29.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/callouts/29.png -------------------------------------------------------------------------------- /webhelp/template/common/images/callouts/3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/callouts/3.png -------------------------------------------------------------------------------- /webhelp/template/common/images/callouts/30.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/callouts/30.png -------------------------------------------------------------------------------- /webhelp/template/common/images/callouts/4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/callouts/4.png -------------------------------------------------------------------------------- /webhelp/template/common/images/callouts/5.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/callouts/5.png -------------------------------------------------------------------------------- /webhelp/template/common/images/callouts/6.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/callouts/6.png -------------------------------------------------------------------------------- /webhelp/template/common/images/callouts/7.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/callouts/7.png -------------------------------------------------------------------------------- /webhelp/template/common/images/callouts/8.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/callouts/8.png -------------------------------------------------------------------------------- /webhelp/template/common/images/callouts/9.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/callouts/9.png -------------------------------------------------------------------------------- /webhelp/template/common/images/header-bg.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/header-bg.gif -------------------------------------------------------------------------------- /webhelp/template/common/images/header-bg.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/header-bg.png -------------------------------------------------------------------------------- /webhelp/template/common/images/highlight-blue.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/highlight-blue.gif -------------------------------------------------------------------------------- /webhelp/template/common/images/highlight-yellow.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/highlight-yellow.gif -------------------------------------------------------------------------------- /webhelp/template/common/images/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/logo.png -------------------------------------------------------------------------------- /webhelp/template/common/images/next-arrow.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/next-arrow.png -------------------------------------------------------------------------------- /webhelp/template/common/images/note.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/note.png -------------------------------------------------------------------------------- /webhelp/template/common/images/previous-arrow.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/previous-arrow.png -------------------------------------------------------------------------------- /webhelp/template/common/images/search-icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/search-icon.png -------------------------------------------------------------------------------- /webhelp/template/common/images/showHideTreeIcons.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/showHideTreeIcons.png -------------------------------------------------------------------------------- /webhelp/template/common/images/sidebar.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/sidebar.png -------------------------------------------------------------------------------- /webhelp/template/common/images/starsSmall.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/starsSmall.png -------------------------------------------------------------------------------- /webhelp/template/common/images/toc-icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/images/toc-icon.png -------------------------------------------------------------------------------- /webhelp/template/common/jquery/theme-redmond/images/ui-anim_basic_16x16.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/jquery/theme-redmond/images/ui-anim_basic_16x16.gif -------------------------------------------------------------------------------- /webhelp/template/common/jquery/theme-redmond/images/ui-bg_flat_0_aaaaaa_40x100.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/jquery/theme-redmond/images/ui-bg_flat_0_aaaaaa_40x100.png -------------------------------------------------------------------------------- /webhelp/template/common/jquery/theme-redmond/images/ui-bg_flat_55_fbec88_40x100.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/jquery/theme-redmond/images/ui-bg_flat_55_fbec88_40x100.png -------------------------------------------------------------------------------- /webhelp/template/common/jquery/theme-redmond/images/ui-bg_glass_75_d0e5f5_1x400.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/jquery/theme-redmond/images/ui-bg_glass_75_d0e5f5_1x400.png -------------------------------------------------------------------------------- /webhelp/template/common/jquery/theme-redmond/images/ui-bg_glass_85_dfeffc_1x400.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/jquery/theme-redmond/images/ui-bg_glass_85_dfeffc_1x400.png -------------------------------------------------------------------------------- /webhelp/template/common/jquery/theme-redmond/images/ui-bg_glass_95_fef1ec_1x400.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/jquery/theme-redmond/images/ui-bg_glass_95_fef1ec_1x400.png -------------------------------------------------------------------------------- /webhelp/template/common/jquery/theme-redmond/images/ui-bg_gloss-wave_55_5c9ccc_500x100.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/jquery/theme-redmond/images/ui-bg_gloss-wave_55_5c9ccc_500x100.png -------------------------------------------------------------------------------- /webhelp/template/common/jquery/theme-redmond/images/ui-bg_inset-hard_100_f5f8f9_1x100.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/jquery/theme-redmond/images/ui-bg_inset-hard_100_f5f8f9_1x100.png -------------------------------------------------------------------------------- /webhelp/template/common/jquery/theme-redmond/images/ui-bg_inset-hard_100_fcfdfd_1x100.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/jquery/theme-redmond/images/ui-bg_inset-hard_100_fcfdfd_1x100.png -------------------------------------------------------------------------------- /webhelp/template/common/jquery/theme-redmond/images/ui-icons_217bc0_256x240.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/jquery/theme-redmond/images/ui-icons_217bc0_256x240.png -------------------------------------------------------------------------------- /webhelp/template/common/jquery/theme-redmond/images/ui-icons_2e83ff_256x240.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/jquery/theme-redmond/images/ui-icons_2e83ff_256x240.png -------------------------------------------------------------------------------- /webhelp/template/common/jquery/theme-redmond/images/ui-icons_469bdd_256x240.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/jquery/theme-redmond/images/ui-icons_469bdd_256x240.png -------------------------------------------------------------------------------- /webhelp/template/common/jquery/theme-redmond/images/ui-icons_6da8d5_256x240.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/jquery/theme-redmond/images/ui-icons_6da8d5_256x240.png -------------------------------------------------------------------------------- /webhelp/template/common/jquery/theme-redmond/images/ui-icons_cd0a0a_256x240.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/jquery/theme-redmond/images/ui-icons_cd0a0a_256x240.png -------------------------------------------------------------------------------- /webhelp/template/common/jquery/theme-redmond/images/ui-icons_d8e7f3_256x240.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/jquery/theme-redmond/images/ui-icons_d8e7f3_256x240.png -------------------------------------------------------------------------------- /webhelp/template/common/jquery/theme-redmond/images/ui-icons_f9bd01_256x240.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/jquery/theme-redmond/images/ui-icons_f9bd01_256x240.png -------------------------------------------------------------------------------- /webhelp/template/common/jquery/treeview/images/file.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/jquery/treeview/images/file.gif -------------------------------------------------------------------------------- /webhelp/template/common/jquery/treeview/images/folder-closed2.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/jquery/treeview/images/folder-closed2.gif -------------------------------------------------------------------------------- /webhelp/template/common/jquery/treeview/images/folder.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/jquery/treeview/images/folder.gif -------------------------------------------------------------------------------- /webhelp/template/common/jquery/treeview/images/folder2.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/jquery/treeview/images/folder2.gif -------------------------------------------------------------------------------- /webhelp/template/common/jquery/treeview/images/minus.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/jquery/treeview/images/minus.gif -------------------------------------------------------------------------------- /webhelp/template/common/jquery/treeview/images/plus.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/jquery/treeview/images/plus.gif -------------------------------------------------------------------------------- /webhelp/template/common/jquery/treeview/images/treeview-black-line.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/jquery/treeview/images/treeview-black-line.gif -------------------------------------------------------------------------------- /webhelp/template/common/jquery/treeview/images/treeview-black.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/jquery/treeview/images/treeview-black.gif -------------------------------------------------------------------------------- /webhelp/template/common/jquery/treeview/images/treeview-default-line.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/jquery/treeview/images/treeview-default-line.gif -------------------------------------------------------------------------------- /webhelp/template/common/jquery/treeview/images/treeview-default.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/jquery/treeview/images/treeview-default.gif -------------------------------------------------------------------------------- /webhelp/template/common/jquery/treeview/images/treeview-famfamfam-line.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/jquery/treeview/images/treeview-famfamfam-line.gif -------------------------------------------------------------------------------- /webhelp/template/common/jquery/treeview/images/treeview-famfamfam.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/jquery/treeview/images/treeview-famfamfam.gif -------------------------------------------------------------------------------- /webhelp/template/common/jquery/treeview/images/treeview-gray-line.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/jquery/treeview/images/treeview-gray-line.gif -------------------------------------------------------------------------------- /webhelp/template/common/jquery/treeview/images/treeview-gray.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/jquery/treeview/images/treeview-gray.gif -------------------------------------------------------------------------------- /webhelp/template/common/jquery/treeview/images/treeview-red-line.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/jquery/treeview/images/treeview-red-line.gif -------------------------------------------------------------------------------- /webhelp/template/common/jquery/treeview/images/treeview-red.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/common/jquery/treeview/images/treeview-red.gif -------------------------------------------------------------------------------- /webhelp/template/common/splitterInit.js: -------------------------------------------------------------------------------- 1 | 2 | var myLayout; 3 | 4 | jQuery(document).ready(function ($) { 5 | 6 | myLayout = $('body').layout({ 7 | //Defining panes 8 | west__paneSelector: "#sidebar" 9 | , north__paneSelector: "#header" 10 | , center__paneSelector: "#content" 11 | 12 | // some resizing/toggling settings 13 | , north__resizable: false // OVERRIDE the pane-default of 'resizable=true' 14 | , north__spacing_open: 0 // no resizer-bar when open (zero height) 15 | , west__slideable: false 16 | , west__spacing_closed: 6 17 | , west__spacing_open: 4 18 | 19 | , 20 | // some pane-size settings 21 | west__minSize: 280 22 | , north__minSize: 99 23 | 24 | // some pane animation settings 25 | , west__animatePaneSizing: false 26 | , west__fxSpeed_size: "normal" 27 | , west__fxSpeed_open: 10 28 | , west__fxSettings_open: {easing: ""} 29 | , west__fxName_close: "none" 30 | 31 | 32 | , stateManagement__enabled: true // automatic cookie load & save enabled by default 33 | , stateManagement__cookie__name: "sidebar_state" 34 | }); 35 | 36 | 37 | 38 | 39 | }); 40 | 41 | -------------------------------------------------------------------------------- /webhelp/template/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/favicon.ico -------------------------------------------------------------------------------- /webhelp/template/search/default.props: -------------------------------------------------------------------------------- 1 | DEF01=a -------------------------------------------------------------------------------- /webhelp/template/search/en-us.props: -------------------------------------------------------------------------------- 1 | DEF01=this 2 | DEF02=is 3 | DEF03=the 4 | DEF04=in 5 | DEF05=i 6 | DEF06=on 7 | DEF07=a 8 | DEF08=about 9 | DEF09=an 10 | DEF10=are 11 | DEF11=as 12 | DEF12=at 13 | DEF13=be 14 | DEF14=by 15 | DEF15=com 16 | DEF16=de 17 | DEF17=en 18 | DEF18=for 19 | DEF19=from 20 | DEF20=how 21 | DEF21=it 22 | DEF22=la 23 | DEF23=of 24 | DEF24=on 25 | DEF25=or 26 | DEF26=that 27 | DEF27=to 28 | DEF28=was 29 | DEF29=what 30 | DEF30=when 31 | DEF31=where 32 | DEF32=who 33 | DEF33=will 34 | DEF34=with 35 | DEF35=und 36 | DEF36=Next 37 | DEF37=Prev 38 | DEF38=Home 39 | DEF39=Motive 40 | DEF40=Inc 41 | DEF41=Copyright 42 | DEF42=All 43 | DEF43=rights 44 | DEF44=reserved 45 | DEF45=Up -------------------------------------------------------------------------------- /webhelp/template/search/es-es.props: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/search/es-es.props -------------------------------------------------------------------------------- /webhelp/template/search/ja-jp.props: -------------------------------------------------------------------------------- 1 | J01=\\u306B -------------------------------------------------------------------------------- /webhelp/template/search/punctuation.props: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MariaDB/connector-c-docs/aa0c2303384442dac0a2d86fb9be8cb31eacce38/webhelp/template/search/punctuation.props -------------------------------------------------------------------------------- /webhelp/xsl/webhelp.xsl: -------------------------------------------------------------------------------- 1 | 2 | 9 | 10 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | --------------------------------------------------------------------------------