C接口函数参考手册范本.doc
《C接口函数参考手册范本.doc》由会员分享,可在线阅读,更多相关《C接口函数参考手册范本.doc(54页珍藏版)》请在三一办公上搜索。
1、word实时数据平台C+接口函数参考手册第一局部用户编程接口说明一、C+语言用户接口函数类实时数据平台在Alpha计算机OPEN VMS操作系统C+编程环境和PC机Visual C+编程环境中提供了C+语言用户接口函数API,供用户编程访问实时数据平台中的数据库。C+语言用户接口函数全部放在CUserApi类中,作为CUserApi类的成员函数。用户建立了CUserApi类的实例以后,就可以直接调用CUserApi类的成员函数实时数据平台中的数据库。二、函数返回值大局部用户接口函数的返回值用于表示函数执行状态。表示函数执行状态的返回值总是一个整型数,当返回值大于零时表示函数执行正确,当返回值小
2、于或等于零时,表示函数执行失败。返回值的意义见各个函数中的说明。三、OPEN VMS操作系统C+编程环境中调用API在Alpha计算机OPEN VMS操作系统C+编程环境中,实时数据平台提供了两个头文件和三个目标模块库。文件分别名称为:两个头文件分别为和,其中分别包含了函数定义和符号定义。用户程序中如果要调用API,必须在程序中用#include包含这两个头文件。用户程序在编译以后要与实时数据平台提供的两个目标模块库连接。连接命令如下:$clink clink是编程环境中提供的一个命令,它完成用户的C+程序与连接库的自动连接。注:为使此命令有郊,用户每次以用户身份进入Open VMS操作系统用
3、户目录下之后,首先执行命令$ RTDBLOG或将此命令加到用户LOGIN命令过程中。四、Windows 95、Windows NT Visual C+编程环境中调用APIVisual C+编程环境中,实时数据平台提供了两个头文件、一个引入库和一个动态连接库。文件分别名称为:两个头文件分别为和,其中分别包含了函数定义和符号定义。用户程序中如果要调用API,必须在程序中用#include包含这两个头文件。在用户程序工作台(Workspace)中,在选单project下选择Settings.,进入设置对话框,选择Link设置,在Object/library Modules下填入。用户程序运行时要保证
4、能找到动态连接库。可以将放在用户程序的目录下,或者放在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_S
5、IMULATE仿真数据库。返回值:指示函数执行状态:不小于1的整数值函数执行成功;小于1的整数值函数执行失败;注:函数执行失败原因可根据返回值参阅附录AAckTagAlarm long AckTagAlarm (char* database, char* tagName, long count, long attr)AckTagAlarm函数确认一个或多个TAG点报警。参数database读数据库名,单数据库系统为NULL。tagName读TAG点名称数组,字符串数组指针。因为仅有PV值有报警数据,这里也可写成: .PV。count读 TAG点个数。attr读数据库属性,说明确认哪种数据库的点
6、,用如下符号表示:RTDB_ATTR_STANDARD标准数据库缺省值);RTDB_ATTR_SIMULATE仿真数据库。返回值:指示函数执行状态:不小于1的整数值函数执行成功;小于1的整数值函数执行失败;注:函数执行失败原因可根据返回值参阅附录AAsciiTime long AsciiTime(TIME_DESC* bTime, char* sTime)AsciiTime函数将二进制时间转换成ASCII时间。参数bTime读二进制时间数据结构。TIME_DESC数据结构格式:typedef struct long time ; TIME_DESC ;其中:time为二进制时间值,flag为二
7、进制时间标志:1表示绝对时间,2表示相对时间,0表示错误。sTime写ASCII时间字符串。返回值:指示函数执行状态:不小于1的整数值函数执行成功;小于1的整数值函数执行失败;注:函数执行失败原因可根据返回值参阅附录ABinaryTime long BinaryTime(char* sTime, TIME_DESC* bTime)BinaryTime函数将ASCII时间转换成二进制时间。参数sTime读ASCII时间字符串。bTime写二进制时间数据结构。TIME_DESC数据结构格式:typedef struct long time ; TIME_DESC ;其中:time为二进制时间值,f
8、lag为二进制时间标志:1表示绝对时间,2表示相对时间,0表示错误。返回值:指示函数执行状态:不小于1的整数值函数执行成功;小于1的整数值函数执行失败;注:函数执行失败原因可根据返回值参阅附录Amit long mit(long viewID) ;mit函数向实时数据平台提交实时数据视图中的数据。参数viewID读实时数据视图标识。返回值:指示函数执行状态:不小于1的整数值函数执行成功;小于1的整数值函数执行失败;注:函数执行失败原因可根据返回值参阅附录ACreateAlarmView long CreateAlarmView(long& viewID, char* database, lon
9、g area, long unit, long viewAttr, long count)CreateAlarmView函数建立报警记录视图。参数viewID写报警记录视图标识。database读数据库名,单数据库系统为NULL。area读区域号,0表示所有区域。unit读单元号,0表示所有单元。viewAttr读视图属性,用如下符号表示:VIEW_ATTR_STATIC静态视图缺省值);VIEW_ATTR_ACTIVE动态视图;VIEW_ATTR_STANDARD标准视图,数据来自系统数据库缺省值);VIEW_ATTR_SIMULATE仿真视图,数据来自仿真数据库。count(读) 视图报警
10、中记录个数。返回值:指示函数执行状态:不小于1的整数值函数执行成功;小于1的整数值函数执行失败;注:函数执行失败原因可根据返回值参阅附录ACreateDataViewlong CreateDataView(long& viewID, char* database, long viewAttr, char* dataDesc, long count) CreateDataView函数建立实时数据视图。参数viewID 写实时数据视图标识。database (读) 数据库名,单数据库系统为NULL。viewAttr (读) 视图属性,用如下符号表示:VIEW_ATTR_READONLY只读视图缺省
11、值);VIEW_ATTR_WRITE可写视图;VIEW_ATTR_STATIC静态视图缺省值);VIEW_ATTR_ACTIVE动态视图;VIEW_ATTR_STANDARD标准视图,数据来自系统数据库缺省值);VIEW_ATTR_SIMULATE仿真视图,数据来自仿真数据库。dataDesc(读) 视图数据TAG点参数描述表,字符串数组指针。数组中元素均为64字节的字符串,每个元素表示一个TAG点参数的描述,TAG点参数的描述为: .。count(读) 点参数描述表中点参数个数。返回值:指示函数执行状态:不小于1的整数值函数执行成功;小于1的整数值函数执行失败;注:函数执行失败原因可根据返回
12、值参阅附录A说明如果TAG点参数描述表中某TAG点仅描述为,如此在建视图时,会按隐式规如此将此TAG点的所有参数的PV项自动建成。CreateDayStaView long CreateDayStaView(long& viewID, char* database, long viewAttr, char* dataDesc, long tagCount, char* endTime, long count) ;CreateDayStaView函数建立日统计数据视图。参数viewID 写日统计数据视图标识。database (读) 数据库名,单数据库系统为NULL。viewAttr (读) 视
13、图属性,用如下符号表示:VIEW_ATTR_STANDARD标准视图,数据来自系统数据库缺省值);VIEW_ATTR_SIMULATE仿真视图,数据来自仿真数据库。dataDesc(读) 视图数据TAG点描述表,字符串数组指针。数组中元素均为64字节的字符串,每个元素表示一个TAG点名称。因为仅有PV值保存统计数据,这里也可写成: .PV。tagCount(读) 视图中TAG点个数。endTime(读) 视图统计数据完毕时间,视图数据完毕时间有三种方法表示:1、 绝对时间,时间格式为“YYYY:MM:DD-HH:MM:SS,意义为“年:月:日-时:分:秒,表示视图数据完毕时间为某一确定时间;2
14、、 当前时间,用NULL时表示;3、 相对时间,时间格式为“DD-HH:MM:SS,意义为“天-时:分:秒表示视图数据完毕时间为当前时间向前减去所表示的相对时间。count(读) 视图中每个点的数据个数。返回值指示函数执行状态:不小于1的整数值函数执行成功;小于1的整数值函数执行失败;注:函数执行失败原因可根据返回值参阅附录A说明日统计数据是作为一种历史数据保存的,到每天的24时保存当天的日统计数据。日统计数据是以天为单位计算的,以每天0时为基准。在上述视图统计数据完毕时间表示法中,用绝对时间表示时,小时、分钟和秒没有意义,函数执行时小时、分钟和秒将被截掉,如“1997:7:30-9:24:1
15、2,作为“1997:7:30-0:0:0处理;用当前时间表示时,最后一个数据是当前日到当前时间的统计数据,如果统计数据完毕时间选择NULL,当前时间是1998年3月5日8时25分36秒,日统计数据视图中最后一个数据是从1998年3月5日到1998年3月5日8时25分36秒的统计数据;用相对时间表示时,相对时间中小时、分钟和秒将被截掉,如“1-9:8:20将被作为“1-0:0:0处理,即日统计数据视图中最后一个数据是当日前一天的数据。CreateEventView long CreateEventView(long& viewID, char* database, long area, long
16、 unit, long viewAttr, long count)CreateEventView函数建立事件记录视图。参数viewID写事件记录视图标识。database读数据库名,单数据库系统为NULL。area读区域号,0表示所有区域。unit读单元号,0表示所有单元。viewAttr读视图属性,用如下符号表示:VIEW_ATTR_STATIC静态视图缺省值);VIEW_ATTR_ACTIVE动态视图;VIEW_ATTR_STANDARD标准视图,数据来自系统数据库缺省值);VIEW_ATTR_SIMULATE仿真视图,数据来自仿真数据库。count(读) 视图中记录个数。返回值:指示函数
17、执行状态:不小于1的整数值函数执行成功;小于1的整数值函数执行失败;注:函数执行失败原因可根据返回值参阅附录ACreateHisView long CreateHisView(long& viewID, char* database, long viewAttr, char* dataDesc, long tagCount, char* endTime, char* spanTime, long count) CreateHisView函数建立历史数据视图。参数viewID 写历史数据视图标识。database (读) 数据库名,单数据库系统为NULL。viewAttr (读) 视图属性,用如
18、下符号表示:VIEW_ATTR_STANDARD标准视图,数据来自系统数据库缺省值);VIEW_ATTR_SIMULATE仿真视图,数据来自仿真数据库。dataDesc(读) 视图数据TAG点描述表,字符串数组指针。数组中元素均为64字节的字符串,每个元素表示一个TAG点名称。因为仅有PV值保存历史数据,这里也可写成: .PV。tagCount(读) 视图中TAG点个数。endTime(读) 视图历史数据完毕时间,视图数据完毕时间有三种方法表示:1、 绝对时间,时间格式为“YYYY:MM:DD-HH:MM:SS,意义为“年:月:日-时:分:秒,表示视图数据完毕时间为某一确定时间;2、 当前时间
19、,用NULL时表示;3、 相对时间,时间格式为“DD-HH:MM:SS,意义为“天-时:分:秒表示视图数据完毕时间为当前时间向前减去所表示的相对时间。spanTime(读) 视图历史数据时间间隔,用相对时间表示,时间格式为“DD-HH:MM:SS,意义为“天-时:分:秒。count(读) 视图中每个点的数据个数。返回值:指示函数执行状态:不小于1的整数值函数执行成功;小于1的整数值函数执行失败;注:函数执行失败原因可根据返回值参阅附录ACreateHourStaView long CreateHourStaView(long& viewID, char* database, long view
20、Attr, char* dataDesc, long tagCount, char* endTime, long count) CreateHourStaView函数建立时统计数据视图。参数viewID 写时统计数据视图标识。database (读) 数据库名,单数据库系统为NULL。viewAttr (读) 视图属性,用如下符号表示:VIEW_ATTR_STANDARD标准视图,数据来自系统数据库缺省值);VIEW_ATTR_SIMULATE仿真视图,数据来自仿真数据库。dataDesc(读) 视图数据TAG点描述表,字符串数组指针。数组中元素均为64字节的字符串,每个元素表示一个TAG点名
21、称。因为仅有PV值保存统计数据,这里也可写成: .PV。tagCount(读) 视图中TAG点个数。endTime(读) 视图统计数据完毕时间,视图数据完毕时间有三种方法表示:1、 绝对时间,时间格式为“YYYY:MM:DD-HH:MM:SS,意义为“年:月:日-时:分:秒,表示视图数据完毕时间为某一确定时间;2、 当前时间,用NULL时表示;3、 相对时间,时间格式为“DD-HH:MM:SS,意义为“天-时:分:秒表示视图数据完毕时间为当前时间向前减去所表示的相对时间。count(读) 视图中每个点的数据个数。返回值:指示函数执行状态:不小于1的整数值函数执行成功;小于1的整数值函数执行失败
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 接口 函数 参考手册 范本
链接地址:https://www.31ppt.com/p-1163812.html