struct st_mysql_client_plugin *mysql_load_plugin(MYSQL
*mysql, const char *name, int type, int argc, ...)
Description
Loads a MySQL client plugin, specified by name and type. An error occurs if the type is invalid or the plugin cannot be loaded.
It is not possible to load multiple plugins of the same type. An error occurs if you try to load a plugin of a type already loaded.
Specify the parameters as follows:
mysql: A pointer to aMYSQLstructure. The plugin API does not require a connection to a MySQL server, but this structure must be properly initialized. The structure is used to obtain connection-related information.name: The name of the plugin to load.type: The type of plugin to load, or –1 to disable type checking. If type is not –1, only plugins matching the type are considered for loading.argc: The number of following arguments (0 if there are none). Interpretation of any following arguments depends on the plugin type.
This function was added in MySQL 5.5.7.
Another way to cause plugins to be loaded is to set the
LIBMYSQL_PLUGINS environment variable to a
semicolon-separated list of plugin names. For example:
shell> export LIBMYSQL_PLUGINS="myplugin1;myplugin2"
Plugins named by LIBMYSQL_PLUGINS are loaded
when the client program calls
mysql_library_init(). No error
is reported if problems occur loading these plugins.
Return Values
A pointer to the plugin if it was loaded successfully.
NULL if an error occurred.
Errors
To check for errors, call the
mysql_error() or
mysql_errno() function. See
Section 22.9.3.15, “mysql_error()”, and
Section 22.9.3.14, “mysql_errno()”.
Example
MYSQL mysql;
if(!mysql_load_plugin(&mysql, "myplugin",
MYSQL_AUTHENTICATION_PLUGIN, 0))
{
fprintf(stderr, "Error: %s\n", mysql_error(&mysql));
exit(-1);
}
See Also
See also Section 22.9.10.3, “mysql_load_plugin()”,
Section 22.9.3.15, “mysql_error()”, Section 22.9.3.14, “mysql_errno()”.