mco_backup_list

接口适用于实时数据库 RT 。

:::

列出备份文件的内容。

此函数会在指定的备份文件中创建一个备份记录列表。该列表包含备份记录的名称、类型、标签及其他属性。

有关概述，请参阅页面C中的增量备份和恢复。

    void	mco_backup_list(	
    	/*IN*/ mco_db_h con,
        /*IN*/ char const* file_name,
        /*IN*/ mco_size_t* backup_list_size,
        /*IN*/ mco_backup_info_t** backup_list,
        /*IN*/ char* err_buf,
        /*IN-OUT*/ unsigned int * err_buf_sz
    )

参数

con

mco_db_h

用于获取备份文件中数据库名称的数据库连接。

file_name

char const*

要列出的备份文件的名称。

backup_list_size

mco_size_t*

指向 mco_size_t 类型变量的指针，该变量将获取返回列表中的记录数。

backup_list

mco_backup_info_t**

指向变量的指针，该变量将指向备份记录描述符的数组。该例程在内部为数组分配内存，需要使用 mco_sys_free() API 将内存返回到内存池。

err_buf

char*

错误描述缓冲区。

err_buf_sz

unsigned int *

在输入时，它指定了 err_buf 的大小。在返回时，它包含写入缓冲区的字符数。如果 err_buf_sz 为 null，则该例程返回 MCO_E_ILLEGAL_PARAM。

返回

MCO_S_OK

成功返回列表。

MCO_E_DISK_OPEN

无法打开备份文件。

示例

    {
        mco_db_h con;
        MCO_RET rc;
        char * filename = “backup.bak”;
        char * label = “a label”;
 
        /* connect to a database */
        rc = mco_db_connect( db_name, &con );
 
        /* backup the database */
        rc = mco_backup_list( con, filename, ... );
    }

文件

• 头文件：mco.h
• 源文件：mcobackup.c
• 库：libmcobackup.a