MySQL in a Nutshell, 2nd Edition

Name

mysql_options()

Synopsis

int mysql_options(MYSQL *mysql, enum mysql_option option, 
                  const char *value)

Use this function to set connection options before a connection has been established using a function such as mysql_real_connect() or mysql_connect(). This function may be used multiple times to set additional options before connecting. For the second argument of the function, you may give specific options for the connection. You may give a value associated with the chosen option for the third argument. Here is an example:

...
mysql = mysql_init(NULL);
mysql_options(mysql, MYSQL_OPT_COMPRESS, NULL);
mysql_real_connect(mysql,host,user,password,NULL,0,NULL,0);
...

The options permitted for the second argument of the function follow, along with the type of variable or value for the third argument in parentheses and a brief explanation of each:

MYSQL_OPT_CONNECT_TIMEOUT (unsigned int *)

This option sets the number of seconds for connection timeout.

MYSQL_OPT_READ_TIMEOUT (unsigned int *)

This option sets the timeout for reads from a Windows MySQL server.

MYSQL_OPT_WRITE_TIMEOUT (unsigned int *)

This option sets the timeout for writes to a Windows MySQL server.

MYSQL_OPT_COMPRESS (NULL)

This option compresses communications between the client and server if supported by both.

MYSQL_OPT_LOCAL_INFILE (pointer to unsigned integer)

This option runs on a file pointed to in the argument. If the pointer is NULL, the LOAD LOCAL INFILE statement is run when connecting.

MYSQL_OPT_NAMED_PIPE (NULL)

This option ...