C接口函数参考手则.doc

实时数据平台 C++接口函数参考手册 － PAGE 54－ 实时数据平台 C++接口函数参考手册 － PAGE 1－ 实时数据平台C++接口函数参考手册 第一部分 用户编程接口说明 一、C++语言用户接口函数类 实时数据平台在Alpha计算机OPEN VMS操作系统C++编程环境和PC机Visual C++编程环境中提供了C++语言用户接口函数（API），供用户编程访问实时数据平台中的数据库。 C++语言用户接口函数全部放在CUserApi类中，作为CUserApi类的成员函数。用户建立了CUserApi类的实例以后，就可以直接调用CUserApi类的成员函数实时数据平台中的数据库。 二、函数返回值 大部分用户接口函数的返回值用于表示函数执行状态。表示函数执行状态的返回值总是一个整型数，当返回值大于零时表示函数执行正确，当返回值小于或等于零时，表示函数执行失败。返回值的意义见各个函数中的说明。 三、OPEN VMS操作系统C++编程环境中调用API 在Alpha计算机OPEN VMS操作系统C++编程环境中，实时数据平台提供了两个头文件和三个目标模块库。文件分别名称为： userapi.h userdef.h viewlib.olb rtdblib.olb baselib.olb 两个头文件分别为userapi.h和userdef.h，其中分别包含了函数定义和符号定义。用户程序中如果要调用API，必须在程序中用#include包含这两个头文件。 用户程序在编译以后要与实时数据平台提供的两个目标模块库连接。连接命令如下： $clink 用户程序程序名 clink是编程环境中提供的一个命令，它完成用户的C++程序与连接库的自动连接。 （注：为使此命令有郊，用户每次以用户身份进入Open VMS操作系统用户目录下之后，首先执行命令‘$ @RTDBLOG’或将此命令加到用户LOGIN命令过程中。） 四、Windows 95、Windows NT Visual C++编程环境中调用API Visual C++编程环境中，实时数据平台提供了两个头文件、一个引入库和一个动态连接库。文件分别名称为： userapi.h userdef.h rtdbapi.lib rdtbapi.dll 两个头文件分别为userapi.h和userdef.h，其中分别包含了函数定义和符号定义。用户程序中如果要调用API，必须在程序中用#include包含这两个头文件。 在用户程序工作台(Workspace)中，在选单project下选择Settings..，进入设置对话框，选择Link设置，在Object/library Modules下填入rtdbapi.lib。 用户程序运行时要保证能找到动态连接库rdtbapi.dll。可以将rdtbapi.dll放在用户程序的目录下，或者放在Windows的system下。 第二部分 用户编程接口（API）成员函数 AckAlarm long AckAlarm(char* database, long area, long unit, long attr) ; AckAlarm函数确认TAG点报警。 参 数 database （读） 数据库名，单数据库系统为NULL。 area （读） 区域号，0表示确认所有区域TAG点报警。 unit （读） 单元号，0表示确认所有单元TAG点报警。 attr （读） 数据库属性，说明确认哪种数据库的点，用下列符号表示： RTDB_ATTR_STANDARD 标准数据库（缺省值)； RTDB_ATTR_SIMULATE 仿真数据库。 返回值： 指示函数执行状态： 不小于1的整数值 函数执行成功； 小于1的整数值 函数执行失败； 注：（函数执行失败原因可根据返回值参阅附录A） AckTagAlarm long AckTagAlarm (char* database, char* tagName, long count, long attr) AckTagAlarm函数确认一个或多个TAG点报警。 参 数 database （读） 数据库名，单数据库系统为NULL。 tagName （读）TAG点名称数组，字符串数组指针。因为仅有PV值有报警数据，这 里也可写成： 点名.PV。 count （读） TAG点个数。 attr （读） 数据库属性，说明确认哪种数据库的点，用下列符号表示： RTDB_ATTR_STANDARD 标准数据库（缺省值)； RTDB_ATTR_SIMULATE 仿真数据库。 返回值： 指示函数执行状态： 不小于1的整数值 函数执行成功； 小于1的整数值