s_mysql_mysql_command_session_state Struct Reference

#include <mysql_command_session_state.h>

Public Attributes
mysql_command_session_state_status(*	init )(MYSQL_H mysql_h, mysql_command_session_state_type type, MYSQL_COMMAND_SESSION_STATE_ITERATOR_H *iterator)
	Initializes an iterator for a session-tracker type. More...
mysql_command_session_state_status(*	get_next )(MYSQL_COMMAND_SESSION_STATE_ITERATOR_H iterator, char *buffer, size_t buffer_length, size_t *length)
	Copies the next iterator item into a caller-provided buffer. More...
void(*	deinit )(MYSQL_COMMAND_SESSION_STATE_ITERATOR_H iterator)
	Releases an iterator returned by init(). More...

Member Data Documentation

deinit

void(* s_mysql_mysql_command_session_state::deinit) (MYSQL_COMMAND_SESSION_STATE_ITERATOR_H iterator)

Releases an iterator returned by init().

Parameters

iterator

Iterator handle.

get_next

mysql_command_session_state_status(* s_mysql_mysql_command_session_state::get_next) (MYSQL_COMMAND_SESSION_STATE_ITERATOR_H iterator, char *buffer, size_t buffer_length, size_t *length)

Copies the next iterator item into a caller-provided buffer.

Parameters

	iterator	Iterator handle returned by init().
[out]	buffer	Output buffer, or NULL to query actual item length.
	buffer_length	Output buffer length in bytes.
[out]	length	Actual item length in bytes.

Returns

Return values

MYSQL_COMMAND_SESSION_STATE_OK	Success. The iterator advances.
MYSQL_COMMAND_SESSION_STATE_END	No further item is available.
MYSQL_COMMAND_SESSION_STATE_INVALID	Invalid input.
MYSQL_COMMAND_SESSION_STATE_BUFFER_TOO_SMALL	The buffer is NULL or too small. length contains the actual item length. The iterator is not advanced.
MYSQL_COMMAND_SESSION_STATE_ERROR	Internal error.

init

mysql_command_session_state_status(* s_mysql_mysql_command_session_state::init) (MYSQL_H mysql_h, mysql_command_session_state_type type, MYSQL_COMMAND_SESSION_STATE_ITERATOR_H *iterator)

Initializes an iterator for a session-tracker type.

Parameters

	mysql_h	Command-service handle.
	type	Session-tracker type to read.
[out]	iterator	Iterator handle.

Returns

Return values

MYSQL_COMMAND_SESSION_STATE_OK	Success. iterator must be released with deinit().
MYSQL_COMMAND_SESSION_STATE_END	No item available for this tracker type.
MYSQL_COMMAND_SESSION_STATE_INVALID	Invalid input.
MYSQL_COMMAND_SESSION_STATE_ERROR	Internal error.

---

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

• include/mysql/components/services/mysql_command_session_state.h