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 или NULL. Функция mysql_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_SNI_SERVERNAME`, `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_LOCAL_INFILE. После успешного возврата вызова, значение infile будет истинным или ложным, чтобы указать, включён ли local_infile.

bool infile;

if (mysql_get_option(mysql, MYSQL_OPT_LOCAL_INFILE, &infile))
  fprintf(stderr, "mysql_get_option() failed\n");