第04单元：接口设计说明书(软件设计文档范例).pdfVIP

LK9000 编程接口说明书 高立开元公司 LK9000 编程接口说明书 第 1 页 LK9000 编程接口说明书 高立开元公司 本接口说明书详细介绍了 LK9000 编程接口函数的功能，用法、声明所在的头文件。 用户在开发 LK9000 软件时必须阅读该说明书。 一、数据库编程接口说明 DB_Initial 【函数原型】void DB_Initial() 【功能】在使用数据库功能时，对数据库管理模块进行初始化。 【声明头文件】dbms.h 【参数说明】无 【返回值说明】无 【使用方法】在要调用其他操作数据库的函数时，首先要进行数据库管理模块初始化。并且 仅被调用一次。 【提示】 DB_Uninitial 【函数原型】void DB_Uninitial() 【功能】释放数据库管理模块所占用的内存、卸载数据库管理模块。 【声明头文件】dbms.h 【参数说明】无 【返回值说明】无 【使用方法】在结束对数据库的操作，最后必须调用该函数卸载数据库管理模块。 DB_Get_Last_Error 【函数原型】char * DB_Get_Last_Error() 【功能】返回数据库操作函数最近一次出错的错误信息。 【声明头文件】dbms.h 【参数说明】无 【返回值说明】返回错误信息的字符串的指针。 【使用方法】 在调用了任何一个的数据库操作函数之后都可以调用该函数捕捉函数运行过程中产生 的错误。 if (DB_Open(usr/db/demo.dbf, hdb) != DB_NO_ERROR) { MessageBox(DB_Get_Last_Error(), ONLY_OK ); } 【提示】 第 2 页 LK9000 编程接口说明书 高立开元公司 DB_Open 【函数原型】int DB_Open(char *File_Name, DB_HANDLE *DB_Handle) 【功能】打开DBF 文件 【声明头文件】dbms.h 【参数说明】 1、File_Name DBF 文件名 2、DB_Handle 正确 返回数据库句柄 错误 0 【返回值说明】 DB_ERROR_OPEN_FILE 数据库打开错误 DB_ERROR_FILE_INVALID 数据库文件无效 DB_ERROR_NOT_ENOUGH_MEM 申请内存失败 DB_ERROR_OPEN_INDEX_FILE 打开索引文件失败 DB_NO_ERROR 执行成功 【使用方法】 DB_HANDLE hdb; DB_Open(/usr/db/demo.dbf, hdb); 【提示】 1、“/usr/db/”为存放数据库文件的路径，打开数据库是务必要加入。 2、打开数据库文件时将索引文件一并打开。 DB_Is_Deleted 【函数原型】int DB_Is_Deleted(DB_HANDLE DB_Handle) 【功能】判断当前记录是否已被删除。 【声明头文件】dbms.h 【参数说明】 1、DB_Handle 数据库句柄 【返回值说明】 DB_ERROR_POINT_INVALID 参数 DB_Handle 所指向的数据库无效 DB_ERROR_RECORD_POSITION 记录位置无效 DB_RECORD_DELETED 当前记录已被删除 DB_RECORD_NOT_DELETE 当前记录未被删除 【使用方法】