blob: 1274f47c4bb7175ac97e5d2524ba42d83a477d1c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
|
.\" Automatically generated by Pandoc 2.5
.\"
.TH "mysql_session_track_get_first" "3" "" "Version 3.3.1" "MariaDB Connector/C"
.hy
.SS Name
.PP
mysql_session_track_get_first \- retrieves first session status change
information
.SS Synopsis
.IP
.nf
\f[C]
#include <mysql.h>
int mysql_session_track_get_first(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_first()\f[R] retrieves the first session
status change information received from the server.
.PP
Depending on the specified type the read only data pointer will contain
the following information: * \f[C]SESSION_TRACK_SCHEMA\f[R]: The name of
the default schema (database) *
\f[C]SESSION_TRACK_SYSTEM_VARIABLES\f[R]: If a session system variable
is changed, the first call contains the name of the changed system
variable, the second call contains the new value.
Both name and value are represented as strings.
* \f[C]SESSION_TRACK_STATE_CHANGE\f[R]: shows whether the session status
has changed.
The value is changed as string \[lq]1\[rq] (changed) or \[lq]0\[rq]
(unchanged).
.PP
Further data needs to be obtained by calling
\f[B]mysql_session_track_get_next(3)\f[R].
.SS Parameter
.IP \[bu] 2
\f[C]mysql\f[R] \- mysql handle, which was previously allocated by
\f[B]mysql_init(3)\f[R] and connected by
\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 Returns
.PP
Zero for success, nonzero if no session tracking information is
available.
.SS History
.PP
\f[C]mysql_session_track_get_first()\f[R] was added in Connector/C 3.0
and MariaDB Server 10.2.
.SS See also
.IP \[bu] 2
\f[B]mysql_session_track_get_next(3)\f[R]
|
