Documentation Home

5.4.32 mysql_get_option()

int
mysql_get_option(MYSQL *mysql,
                 enum mysql_option option,
                 const void *arg)

描述

返回可使用 设置的选项的当前值 mysql_options()。该值应被视为只读。

option参数是您想要其值的选项 。arg参数是指向存储选项值的变量的指针 。arg必须是指向适合option参数的类型的变量的指针。下表显示了用于每个 option值的变量类型。

对于MYSQL_OPT_MAX_ALLOWED_PACKET,可以设置会话或全局最大缓冲区大小,具体取决于mysql参数 mysql_options()是非NULL还是NULLmysql_get_option()同样根据其 mysql参数返回会话或全局值。

arg类型 适用option
unsigned int MYSQL_OPT_CONNECT_TIMEOUT,,,,,,,, MYSQL_OPT_PROTOCOL_ MYSQL_OPT_READ_TIMEOUT_ MYSQL_OPT_RETRY_COUNT_ MYSQL_OPT_SSL_FIPS_MODE_ MYSQL_OPT_SSL_MODE_ MYSQL_OPT_WRITE_TIMEOUT_ MYSQL_OPT_ZSTD_COMPRESSION_LEVEL
unsigned long MYSQL_OPT_MAX_ALLOWED_PACKET, MYSQL_OPT_NET_BUFFER_LENGTH
bool MYSQL_ENABLE_CLEARTEXT_PLUGIN,,,,,,, MYSQL_OPT_CAN_HANDLE_EXPIRED_PASSWORDS_ MYSQL_OPT_GET_SERVER_PUBLIC_KEY_ MYSQL_OPT_LOCAL_INFILE_ MYSQL_OPT_OPTIONAL_RESULTSET_METADATA_ MYSQL_OPT_RECONNECT_ MYSQL_REPORT_DATA_TRUNCATION
const char * MYSQL_DEFAULT_AUTH,,,,,,,,,,,,,,,,,,,,,,, MYSQL_OPT_BIND_ MYSQL_OPT_COMPRESSION_ALGORITHMS_ MYSQL_OPT_LOAD_DATA_LOCAL_DIR_ MYSQL_OPT_SSL_CA_ MYSQL_OPT_SSL_CAPATH_ MYSQL_OPT_SSL_CERT_ MYSQL_OPT_SSL_CIPHER_ MYSQL_OPT_SSL_CRL_ MYSQL_OPT_SSL_CRLPATH_ MYSQL_OPT_SSL_KEY_ MYSQL_OPT_TLS_CIPHERSUITES_ MYSQL_OPT_TLS_VERSION_ MYSQL_PLUGIN_DIR_ MYSQL_READ_DEFAULT_FILE_ MYSQL_READ_DEFAULT_GROUP_ MYSQL_SERVER_PUBLIC_KEY_ MYSQL_SET_CHARSET_DIR_ MYSQL_SET_CHARSET_NAME_ MYSQL_SHARED_MEMORY_BASE_NAME
void MYSQL_OPT_SSL_SESSION_DATA
未使用参数 MYSQL_OPT_COMPRESS
无法查询(返回错误) MYSQL_INIT_COMMAND, MYSQL_OPT_CONNECT_ATTR_DELETE, MYSQL_OPT_CONNECT_ATTR_RESET, MYSQL_OPT_NAMED_PIPE

返回值

零成功。如果发生错误则非零;option对于无法查询 的值,会发生这种情况。

例子

以下调用测试该 MYSQL_OPT_RECONNECT选项。调用成功后返回 reconnecttrue或false表示是否开启自动重连。

bool reconnect;

if (mysql_get_option(mysql, MYSQL_OPT_RECONNECT, &reconnect))
  fprintf(stderr, "mysql_get_option() failed\n");