Files
mariadb-connector-c/man/mariadb_rpl_optionsv.3
Georg Richter 10c67ee835 Man page fixes:
- Install created man pages when building with WITH_DOCS=ON
- Set version to 3.4
2024-10-25 10:37:47 +02:00

99 lines
1.5 KiB
Groff

'\" t
.\" Automatically generated by Pandoc 3.5
.\"
.TH "mariadb_rpl_optionsv" "3" "" "Version 3.4" "MariaDB Connector/C"
.SS Name
mariadb_rpl_optionsv \- sets replication options
.SS Synopsis
.IP
.EX
#include \f[B]<mariadb_rpl.h>\f[R]
int mariadb_rpl_optionsv(MARIADB_RPL *rpl, \f[B]enum\f[R] mariadb_rpl_option option, ...)
.EE
.SS Parameter
.IP \[bu] 2
\f[CR]rpl\f[R] \- a replication handle which was previously allocated by
mariadb_rpl_init
.IP \[bu] 2
\f[CR]option\f[R] \- The option to be set, followed by one or more
values
.PP
.TS
tab(@);
lw(23.3n) lw(23.3n) lw(23.3n).
T{
Option
T}@T{
Type
T}@T{
Description
T}
_
T{
MARIADB_RPL_FILENAME
T}@T{
char *
T}@T{
The name of binglog file
T}
T{
MARIADB_RPL_START
T}@T{
unsigned long
T}@T{
Start position
T}
T{
MARIADB_RPL_SERVER_ID
T}@T{
uint32_t
T}@T{
Server id
T}
T{
MARIADB_RPL_FLAGS
T}@T{
uint32_t
T}@T{
Flags
T}
T{
MARIADB_RPL_VERIFY_CHECKSUM
T}@T{
uint32_t
T}@T{
Verify CRC32 checksum (option added in version 3.3.5)
T}
T{
MARIADB_RPL_PORT
T}@T{
uint32_t
T}@T{
Port of replication client (option added in version 3.3.5)
T}
T{
MARIADB_RPL_HOST
T}@T{
char *
T}@T{
Name of replication client (option added in version 3.3.5)
T}
T{
MARIADB_RPL_SEMI_SYNC
T}@T{
uint_32_t
T}@T{
Enable or disable semi sync replication (option added in version 3.3.6).
T}
.TE
.SS Return value
Returns zero on success, non zero on error.
.SS See also
.IP \[bu] 2
\f[B]mariadb_rpl_get_optionsv(3)\f[R]
.IP \[bu] 2
\f[B]mariadb_rpl_open(3)\f[R]
.SS History
\f[CR]mariadb_rpl_optionsv\f[R] was added in MariaDB Connector/C 3.1.0