MySQL :: MySQL 8.4 C API Developer Guide :: 10.4.3 mysql_binlog_open() (original) (raw)

10.4.3 mysql_binlog_open()

int
mysql_binlog_open(MYSQL *mysql,
                  MYSQL_RPL *rpl)

Description

Open a new replication event stream, to read a MySQL server binary log.

Arguments:

• mysql: The connection handler returned from mysql_init().
• rpl: A MYSQL_RPL structure that has been initialized to indicate the replication event stream source. For a description of the structure members and how to initialize them, seeSection 10.2, “C API Binary Log Data Structures”.

Return Values

Zero for success. Nonzero if an error occurred.

Errors

• CR_FILE_NAME_TOO_LONG
  The specified binary log file name was too long.
• CR_OUT_OF_MEMORY
  Out of memory.