summaryrefslogtreecommitdiffstats
path: root/libmariadb/man/mysql_session_track_get_next.3
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-13 12:24:36 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-13 12:24:36 +0000
commit06eaf7232e9a920468c0f8d74dcf2fe8b555501c (patch)
treee2c7b5777f728320e5b5542b6213fd3591ba51e2 /libmariadb/man/mysql_session_track_get_next.3
parentInitial commit. (diff)
downloadmariadb-06eaf7232e9a920468c0f8d74dcf2fe8b555501c.tar.xz
mariadb-06eaf7232e9a920468c0f8d74dcf2fe8b555501c.zip
Adding upstream version 1:10.11.6.upstream/1%10.11.6
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'libmariadb/man/mysql_session_track_get_next.3')
-rw-r--r--libmariadb/man/mysql_session_track_get_next.362
1 files changed, 62 insertions, 0 deletions
diff --git a/libmariadb/man/mysql_session_track_get_next.3 b/libmariadb/man/mysql_session_track_get_next.3
new file mode 100644
index 00000000..5b849ef7
--- /dev/null
+++ b/libmariadb/man/mysql_session_track_get_next.3
@@ -0,0 +1,62 @@
+.\" Automatically generated by Pandoc 2.5
+.\"
+.TH "mysql_session_track_get_next" "3" "" "Version 3.3.1" "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]