1
0
mirror of https://github.com/VCMP-SqMod/SqMod.git synced 2024-11-08 16:57:16 +01:00
SqMod/vendor/MDBC/man/mysql_session_track_get_next.3

63 lines
1.7 KiB
Groff
Raw Normal View History

.\" Automatically generated by Pandoc 2.5
.\"
.TH "mysql_session_track_get_next" "3" "" "Version 3.2.2" "MariaDB Connector/C"
.hy
.SS Name
.PP
mysql_session_track_get_next \- Retrieves the next session status change
information
.SS Synopsis
.IP
.nf
\f[C]
#include <mysql.h>
int mysql_session_track_get_next(MYSQL * mysql,
enum enum_session_state_type type,
const char **data,
size_t *length );
\f[R]
.fi
.SS Description
.PP
\f[C]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[C]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[C]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[C]type\f[R] \- type of information.
Valid values are
.RS 2
.IP \[bu] 2
\f[C]SESSION_TRACK_SYSTEM_VARIABLES\f[R]
.IP \[bu] 2
\f[C]SESSION_TRACK_SCHEMA\f[R]
.IP \[bu] 2
\f[C]SESSION_TRACK_STATE_CHANGE\f[R]
.IP \[bu] 2
\f[C]SESSION_TRACK_GTIDS\f[R] (unsupported)
.RE
.IP \[bu] 2
\f[C]data\f[R] \- pointer to data, which must be declared as
\f[C]const char *\f[R]
.IP \[bu] 2
\f[C]length\f[R] \- pointer to a \f[C]size_t\f[R] variable, which will
contain the length of data
.SS Return value
.PP
Zero for success, nonzero if an error occurred.
.SS History
.PP
\f[C]mysql_session_track_get_next()\f[R] was added in Connector/C 3.0
and MariaDB Server 10.2.
.SS See also
.PP
\f[B]mysql_session_track_get_first(3)\f[R]