MySQL 8.0.32
Source Code Documentation
s_mysql_mysql_connection_attributes_iterator Struct Reference

#include <mysql_connection_attributes_iterator.h>

Public Attributes

mysql_service_status_t(* init )(MYSQL_THD thd, my_h_connection_attributes_iterator *iterator)
 Initialize an iterator. More...
 
mysql_service_status_t(* deinit )(my_h_connection_attributes_iterator iterator)
 Deinitialize an iterator. More...
 
mysql_service_status_t(* get )(MYSQL_THD thd, my_h_connection_attributes_iterator *iterator, const char **name, size_t *name_length, const char **value, size_t *value_length, const char **client_charset)
 Fetch the current name/value pair from the iterator and move it forward. More...
 

Member Data Documentation

◆ deinit

mysql_service_status_t(* s_mysql_mysql_connection_attributes_iterator::deinit) (my_h_connection_attributes_iterator iterator)

Deinitialize an iterator.

Parameters
iteratorIterator pointer.
Returns
Return values
falseSucceeded.
trueFailed.
See also
mysql_connection_attributes_iterator_imp::deinit

◆ get

mysql_service_status_t(* s_mysql_mysql_connection_attributes_iterator::get) (MYSQL_THD thd, my_h_connection_attributes_iterator *iterator, const char **name, size_t *name_length, const char **value, size_t *value_length, const char **client_charset)

Fetch the current name/value pair from the iterator and move it forward.

Note: the attribute's name and value pointers are valid until the THD object is alive.

Parameters
thdThe session to operate on. Can be NULL to use the current THD.
iteratorIterator pointer.
[out]nameThe attribute name.
[out]name_lengthThe attribute name's length.
[out]valueThe attribute value.
[out]value_lengthThe attribute value's length.
[out]client_charsetThe character set, used for encoding the connection attributes pair
Returns
Return values
falseSucceeded.
trueFailed.
See also
mysql_connection_attributes_iterator_imp::get

◆ init

mysql_service_status_t(* s_mysql_mysql_connection_attributes_iterator::init) (MYSQL_THD thd, my_h_connection_attributes_iterator *iterator)

Initialize an iterator.

Also position at the first attribute.

Parameters
thdThe session to operate on. Can be NULL to use the current THD.
[out]iteratorIterator pointer.
Returns
Return values
falseSucceeded.
trueFailed.
See also
mysql_connection_attributes_iterator_imp::init

The documentation for this struct was generated from the following file: