mysql_connection_attributes_iterator_imp Class Reference

#include <mysql_connection_attributes_iterator_imp.h>

Static Public Member Functions
static mysql_service_status_t	init (THD *opaque_thd, my_h_connection_attributes_iterator *iterator) noexcept
	Initialize an iterator. More...
static mysql_service_status_t	deinit (my_h_connection_attributes_iterator iterator) noexcept
	Deinitialize an iterator. More...
static mysql_service_status_t	get (THD *opaque_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) noexcept
	Fetch the current name/value pair from the iterator and move it forward. More...

Member Function Documentation

deinit()

mysql_service_status_t mysql_connection_attributes_iterator_imp::deinit ( my_h_connection_attributes_iterator  iterator )

staticnoexcept

Deinitialize an iterator.

Parameters

iterator

Iterator pointer.

Returns

Return values

false	Succeeded.
true	Failed.

See also

mysql_connection_attributes_iterator::deinit

get()

mysql_service_status_t mysql_connection_attributes_iterator_imp::get ( THD *  opaque_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  )

staticnoexcept

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

	opaque_thd	The session to operate on. Can be NULL to use the current THD.
	iterator	Iterator pointer.
[out]	name	The attribute name.
[out]	name_length	The attribute name's length.
[out]	value	The attribute value.
[out]	value_length	The attribute value's length.
[out]	client_charset	The character set, used for encoding the connection attributes pair

Returns

Return values

false	Succeeded.
true	Failed.

See also

mysql_connection_attributes_iterator::get

init()

mysql_service_status_t mysql_connection_attributes_iterator_imp::init ( THD *  opaque_thd, my_h_connection_attributes_iterator *  iterator  )

staticnoexcept

Initialize an iterator.

Also position at the first attribute.

Parameters

	opaque_thd	The session to operate on. Can be null to use the current THD.
[out]	iterator	Iterator pointer.

Returns

Return values

false	Succeeded.
true	Failed.

See also

mysql_connection_attributes_iterator::init

---

The documentation for this class was generated from the following files:

• sql/server_component/mysql_connection_attributes_iterator_imp.h
• sql/server_component/mysql_connection_attributes_iterator_imp.cc