mirror of
https://github.com/mariadb-corporation/mariadb-connector-c.git
synced 2025-07-26 08:41:58 +00:00
55 lines
1.7 KiB
Groff
55 lines
1.7 KiB
Groff
.\" Automatically generated by Pandoc 3.5
|
|
.\"
|
|
.TH "mysql_session_track_get_next" "3" "" "Version 3.4" "MariaDB Connector/C"
|
|
.SS Name
|
|
mysql_session_track_get_next \- Retrieves the next session status change
|
|
information
|
|
.SS Synopsis
|
|
.IP
|
|
.EX
|
|
#include \f[B]<mysql.h>\f[R]
|
|
|
|
int mysql_session_track_get_next(MYSQL * mysql,
|
|
\f[B]enum\f[R] enum_session_state_type type,
|
|
const char **data,
|
|
size_t *length );
|
|
.EE
|
|
.SS Description
|
|
\f[CR]mysql_session_track_get_next()\f[R] retrieves the session status
|
|
change information received from the server after a successful call to
|
|
\f[B]mysql_session_track_get_first(3)\f[R].
|
|
.PP
|
|
\f[CR]mysql_session_track_get_next()\f[R] needs to be called repeatedly
|
|
until a non zero return value indicates end of data.
|
|
.SS Parameters
|
|
.IP \[bu] 2
|
|
\f[CR]mysql\f[R] \- mysql handle, which was previously allocated by
|
|
\f[B]mysql_init(3)\f[R] and connected bys
|
|
\f[B]mysql_real_connect(3)\f[R].
|
|
.IP \[bu] 2
|
|
\f[CR]type\f[R] \- type of information.
|
|
Valid values are
|
|
.RS 2
|
|
.IP \[bu] 2
|
|
\f[CR]SESSION_TRACK_SYSTEM_VARIABLES\f[R]
|
|
.IP \[bu] 2
|
|
\f[CR]SESSION_TRACK_SCHEMA\f[R]
|
|
.IP \[bu] 2
|
|
\f[CR]SESSION_TRACK_STATE_CHANGE\f[R]
|
|
.IP \[bu] 2
|
|
\f[CR]SESSION_TRACK_GTIDS\f[R] (unsupported)
|
|
.RE
|
|
.IP \[bu] 2
|
|
\f[CR]data\f[R] \- pointer to data, which must be declared as
|
|
\f[CR]const char *\f[R]
|
|
.IP \[bu] 2
|
|
\f[CR]length\f[R] \- pointer to a \f[CR]size_t\f[R] variable, which will
|
|
contain the length of data
|
|
.SS Return value
|
|
Zero for success, nonzero if an error occurred.
|
|
.SS History
|
|
\f[CR]mysql_session_track_get_next()\f[R] was added in Connector/C 3.0
|
|
and MariaDB Server 10.2.
|
|
.SS See also
|
|
\f[B]mysql_session_track_get_first(3)\f[R]
|