实时数据平台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的整数值函数执行失败;
注:(函数执行失败原因可根据返回值参阅附录A)
AsciiTime
long AsciiTime(TIME_DESC* bTime, char* sTime)
AsciiTime函数将二进制时间转换成ASCII时间。
参数
bTime (读)二进制时间数据结构。
TIME_DESC数据结构格式:
typedef struct
{
long time ;
long flag ; // 0.Error, 1.Absolute, 2.Relative
} TIME_DESC ;
其中:time为二进制时间值,flag为二进制时间标志:1表示绝对时间,2表示相对时间,0表示错误。
sTime (写)ASCII时间字符串。
返回值:
指示函数执行状态:
不小于1的整数值函数执行成功;
小于1的整数值函数执行失败;
注:(函数执行失败原因可根据返回值参阅附录A)
BinaryTime
long BinaryTime(char* sTime, TIME_DESC* bTime)
BinaryTime函数将ASCII时间转换成二进制时间。
参数
sTime (读)ASCII时间字符串。
bTime (写)二进制时间数据结构。
TIME_DESC数据结构格式:
typedef struct
{
long time ;
long flag ; // 0.Error, 1.Absolute, 2.Relative
} TIME_DESC ;
其中:time为二进制时间值,flag为二进制时间标志:1表示绝对时间,2
表示相对时间,0表示错误。
返回值:
指示函数执行状态:
不小于1的整数值函数执行成功;
小于1的整数值函数执行失败;
注:(函数执行失败原因可根据返回值参阅附录A)
Commit
long Commit(long viewID) ;
Commit函数向实时数据平台提交实时数据视图中的数据。
参数
viewID (读)实时数据视图标识。
返回值:
指示函数执行状态:
不小于1的整数值函数执行成功;
小于1的整数值函数执行失败;
注:(函数执行失败原因可根据返回值参阅附录A)
CreateAlarmView
long CreateAlarmView(long& viewID, char* database,
long 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(读) 视图报警中记录个数。
返回值:
指示函数执行状态:
不小于1的整数值函数执行成功;
小于1的整数值函数执行失败;
注:(函数执行失败原因可根据返回值参阅附录A)
CreateDataView
long CreateDataView(long& viewID, char* database, long viewAttr,
char* dataDesc, long count) CreateDataView函数建立实时数据视图。
参数
viewID (写)实时数据视图标识。
database (读) 数据库名,单数据库系统为NULL。
viewAttr (读) 视图属性,用下列符号表示:
VIEW_ATTR_READONLY 只读视图(缺省值);
VIEW_ATTR_WRITE 可写视图;
VIEW_ATTR_STATIC 静态视图(缺省值);
VIEW_ATTR_ACTIVE 动态视图;
VIEW_ATTR_STANDARD 标准视图,数据来自系统数据库(缺省值);
VIEW_ATTR_SIMULATE 仿真视图,数据来自仿真数据库。
dataDesc (读) 视图数据TAG点参数描述表,字符串数组指针。数组中元素均为64字节的字符串,每个元素表示一个TAG点参数的描述,
TAG点参数的描述为:
<点名>.<参数名>.<细目名>。
count(读) 点参数描述表中点参数个数。
返回值:
指示函数执行状态:
不小于1的整数值函数执行成功;
小于1的整数值函数执行失败;
注:(函数执行失败原因可根据返回值参阅附录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 (读) 视图属性,用下列符号表示:
VIEW_ATTR_STANDARD 标准视图,数据来自系统数据库(缺省值);
VIEW_ATTR_SIMULATE 仿真视图,数据来自仿真数据库。
dataDesc (读) 视图数据TAG点描述表,字符串数组指针。数组中元素均为64字节的字符串,每个元素表示一个TAG点名称。因为仅有PV
值保存统计数据,这里也可写成: <点名>.PV。
tagCount (读) 视图中TAG点个数。
endTime (读) 视图统计数据结束时间,视图数据结束时间有三种方法表示:
1、绝对时间,时间格式为“YYYY:MM:DD-HH:MM:SS”,意义为“年:月:
日-时:分:秒”,表示视图数据结束时间为某一确定时间;
2、当前时间,用NULL时表示;
3、相对时间,时间格式为“DD-HH:MM:SS”,意义为“天-时:分:秒”
表示视图数据结束时间为当前时间向前减去所表示的相对时间。
count(读) 视图中每个点的数据个数。
返回值
指示函数执行状态:
不小于1的整数值函数执行成功;
小于1的整数值函数执行失败;
注:(函数执行失败原因可根据返回值参阅附录A)
说明
日统计数据是作为一种历史数据保存的,到每天的24时保存当天的日统计数据。日统计数据是以天为单位计算的,以每天0时为基准。在上述视图统计数据结束时间表示法中,用绝对时间表示时,小时、分钟和秒没有意义,函数执行时小时、分钟和秒将被截掉,如“1997:7:30-9:24:12”,作为“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 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(读) 视图中记录个数。
返回值:
指示函数执行状态:
不小于1的整数值函数执行成功;
小于1的整数值函数执行失败;
注:(函数执行失败原因可根据返回值参阅附录A)
CreateHisView
long CreateHisView(long& viewID, char* database, long viewAttr, char* dataDesc,
long tagCount, char* endTime, char* spanTime, long count) CreateHisView函数建立历史数据视图。
参数
viewID (写)历史数据视图标识。
database (读) 数据库名,单数据库系统为NULL。
viewAttr (读) 视图属性,用下列符号表示:
VIEW_ATTR_STANDARD 标准视图,数据来自系统数据库(缺省值);
VIEW_ATTR_SIMULATE 仿真视图,数据来自仿真数据库。
dataDesc (读) 视图数据TAG点描述表,字符串数组指针。数组中元素均为64字节的字符串,每个元素表示一个TAG点名称。因为仅有PV
值保存历史数据,这里也可写成: <点名>.PV。
tagCount (读) 视图中TAG点个数。
endTime (读) 视图历史数据结束时间,视图数据结束时间有三种方法表示:
1、绝对时间,时间格式为“YYYY:MM:DD-HH:MM:SS”,意义为“年:月:
日-时:分:秒”,表示视图数据结束时间为某一确定时间;
2、当前时间,用NULL时表示;
3、相对时间,时间格式为“DD-HH:MM:SS”,意义为“天-时:分:秒”
表示视图数据结束时间为当前时间向前减去所表示的相对时间。
spanTime (读) 视图历史数据时间间隔,用相对时间表示,时间格式为“DD-HH:MM:SS”,意义为“天-时:分:秒”。
count(读) 视图中每个点的数据个数。
返回值:
指示函数执行状态:
不小于1的整数值函数执行成功;
小于1的整数值函数执行失败;
注:(函数执行失败原因可根据返回值参阅附录A)
CreateHourStaView
long CreateHourStaView(long& viewID, char* database, long viewAttr, char* dataDesc, long tagCount, char* endTime, long count) CreateHourStaView函数建立时统计数据视图。
参数
viewID (写)时统计数据视图标识。
database (读) 数据库名,单数据库系统为NULL。
viewAttr (读) 视图属性,用下列符号表示:
VIEW_ATTR_STANDARD 标准视图,数据来自系统数据库(缺省值);
VIEW_ATTR_SIMULATE 仿真视图,数据来自仿真数据库。
dataDesc (读) 视图数据TAG点描述表,字符串数组指针。数组中元素均为64字节的字符串,每个元素表示一个TAG点名称。因为仅有PV
值保存统计数据,这里也可写成: <点名>.PV。
tagCount (读) 视图中TAG点个数。
endTime (读) 视图统计数据结束时间,视图数据结束时间有三种方法表示:
1、绝对时间,时间格式为“YYYY:MM:DD-HH:MM:SS”,意义为“年:月:
日-时:分:秒”,表示视图数据结束时间为某一确定时间;
2、当前时间,用NULL时表示;
3、相对时间,时间格式为“DD-HH:MM:SS”,意义为“天-时:分:秒”
表示视图数据结束时间为当前时间向前减去所表示的相对时间。
count(读) 视图中每个点的数据个数。
返回值:
指示函数执行状态:
不小于1的整数值函数执行成功;
小于1的整数值函数执行失败;
注:(函数执行失败原因可根据返回值参阅附录A)
说明
时统计数据是作为一种历史数据保存的,到每小时的60分钟结束时保存这个小时的时统计数据。时统计数据是以小时为单位计算的,以每小时0分为基准。在上述视图统计数据结束时间表示法中,用绝对时间表示时,分钟和秒没有意义,函数执行时分钟和秒将被截掉,如“1997:7:30-9:24:12”,作为“1997:7:30-9:0:0”处理;用当前时间表示时,最后一个数据是本小时0分到当前时间的统计数据,如果统计数据结束时间选择NULL,当前时间是1998年3月5日8时25分36秒,日统计数据视图中最后一个数据是从1998年3月5日8时到1998年3月5日8时25分36秒的统计数据;用相对时间表示时,相对时间中分钟和秒将被截掉,如“0-1:15:20”将被作为“0-1:0:0”
处理,即时统计数据视图中最后一个数据是当日前一小时的数据。
CreateTagAlarmView
long CreateTagAlarmView(long& viewID, char* database,
char* tagName, long viewAttr, long count) CreateTagAlarmView函数建立单点报警记录视图。
参数
viewID (写)报警记录视图标识。
database (读)数据库名,单数据库系统为NULL。
tagName (读)视图中的一个TAG点名称,字符串指针。因为仅有PV值有报警数据,这里也可写成: <点名>.PV。
viewAttr (读)视图属性,用下列符号表示:
VIEW_ATTR_STATIC 静态视图(缺省值);
VIEW_ATTR_ACTIVE 动态视图;
VIEW_ATTR_STANDARD 标准视图,数据来自系统数据库(缺省值);
VIEW_ATTR_SIMULATE 仿真视图,数据来自仿真数据库。
count(读) 视图中记录个数。
返回值:
指示函数执行状态:
不小于1的整数值函数执行成功;
小于1的整数值函数执行失败;
注:(函数执行失败原因可根据返回值参阅附录A)
CreateTagEventView
long CreateTagEventView(long& viewID, char* database,
char* tagDesc, long viewAttr, long count) CreateTagEventView函数建立单点事件记录视图。
参数
viewID (写)事件记录视图标识。
database (读)数据库名,单数据库系统为NULL。
tagDesc (读)视图中的一个TAG点参数描述,字符串指针。如果仅写TAG点名称,取这个TAG点所有参数发生的所有事件;如果写成:
viewAttr (读)视图属性,用下列符号表示:
VIEW_ATTR_STATIC 静态视图(缺省值);
VIEW_ATTR_ACTIVE 动态视图;
VIEW_ATTR_STANDARD 标准视图,数据来自系统数据库(缺省值);
VIEW_ATTR_SIMULATE 仿真视图,数据来自仿真数据库。
count(读) 视图中记录个数。
返回值:
指示函数执行状态:
不小于1的整数值函数执行成功;
小于1的整数值函数执行失败;
注:(函数执行失败原因可根据返回值参阅附录A)
DeleteView
long DeleteView(long viewID)
DeleteView函数删除数据视图。
参数
viewID (读)数据视图标识。
返回值:
指示函数执行状态:
不小于1的整数值函数执行成功;
小于1的整数值函数执行失败;
注:(函数执行失败原因可根据返回值参阅附录A)
EnableUserWriteDevice
long EnableUserWriteDevice(long onOff)
EnableUserWriteDevice函数设置用户级的允许/禁止回送现场设备数据控制开关。
参数
onOff (读)控制开关,控制开关的开关状态用下列符号表示:ENABLE_WRITE_DEVICE 开状态,即允许回送现场设备数据;
DISABLE_WRITE_DEVICE 关状态,即禁止回送现场设备数据;
返回值
指示函数执行状态:
不小于1的整数值函数执行成功;
小于1的整数值函数执行失败;
注:(函数执行失败原因可根据返回值参阅附录A)
说明
缺省情况下,每个用户被设成禁止回送现场设备状态,每个视图被设成允许回送现场设备状态但只有用户和视图都被设成允许回送现场设备状态数据才能真正回送。如果某个用户被设成允许回送现场设备状态,则它所建的每个视图缺省情况下均被设成允许回送现场设备状态,此时进行视图提交的话就会将数据回送到下位机(或现场设备)。这时候也可以把具体某一个视图设成禁止回送现场设备状态。
参见 EnableViewWriteDevice
EnableViewWriteDevice
long EnableViewWriteDevice(long viewID, long onOff)
EnableViewWriteDevice函数设置视图级的允许/禁止回送现场设备数据控制开关。
参数
viewID (读)实时数据视图标识。
onOff (读)控制开关,控制开关的开关状态用下列符号表示:ENABLE_WRITE_DEVICE 开状态,即允许回送现场设备数据;
DISABLE_WRITE_DEVICE 关状态,即禁止回送现场设备数据;
返回值
指示函数执行状态:
不小于1的整数值函数执行成功;
小于1的整数值函数执行失败;
注:(函数执行失败原因可根据返回值参阅附录A)
说明
缺省情况下,每个用户被设成禁止回送现场设备状态,每个视图被设成允许回送现场设备状态但只有用户和视图都被设成允许回送现场设备状态数据才能真正回送。如果某个用户被设成允许回送现场设备状态,则它所建的每个视图缺省情况下均被设成允许回送现场设备状态,此时进行视图提交的话就会将数据回送到下位机(或现场设备)。这时候也可以把具体某一个视图设成禁止回送现场设备状态。
参见 EnableUserWriteDevice
GetDataCommitFlag
long GetDataCommitFlag(long viewID, long dataID)
GetDataCommitFlag函数读实时数据视图中数据的提交标志,检测数据是否被提交。
参数
viewID (读)实时数据视图标识。
dataID (读) TAG点参数数据标识。
返回值:
1:数据被提交;
0:数据未被提交;
小于0的整数值:函数执行失败;
注:(函数执行失败原因可根据返回值参阅附录A)
参见 GetDataID
GetDataCommitStatus
long GetDataCommitStatus(long viewID, long dataID, long& commitStatus) GetDataCommiStatus函数读实时数据视图中数据向实时数据库中提交后的状态,检测数据是否被提交到实时数据库中。
参数
viewID (读)实时数据视图标识。
dataID (读) TAG点参数数据标识。
commitStatus(写) 实时数据视图中数据向实时数据库中提交后的状态。可能的状态值及其意义如下:
Data_Success 1 数据成功提交
Data_NotChange 2 成功提交与前一值相同的数据
Data_SourceError -5 由于数据源错误提交失败
Data_UserLevelError -6 由于用户级别错误提交失败
Data_TagStateError -7 由于点状态错误提交失败
Data_ReadOnly -8 由于数据源只读提交失败
Data_HighLimit -9 发生超高限错误提交失败
Data_LowLimit -10 发生超低限错误提交失败
Data_OutputDisable -21 由于输出禁止发生输出失败(数据写入数据库但不能向外设输出)
Data_OutputHighLimit -22 由于输出超高限发生输出失败(数据写入数据库但不能向外设输出)
Data_OutputLowLimit -23 由于输出超低限发生输出失败(数据写入数据库但不能向外设输出)
Data_OutputModeError -25 由于输出方式错误发生输出失败(数据写入数据库但不能向外设输出)
Data_OutputStateError -26 由于输出状态错误发生输出失败(数据写入数据库但不能向外设输出)
返回值:
指示函数执行状态:
不小于1的整数值函数执行成功;
小于1的整数值函数执行失败;
注:(函数执行失败原因可根据返回值参阅附录A)
说明
缺省情况下,每个用户被设成禁止回送现场设备状态,每个视图被设成允许回送现场设备
参见 GetDataID
GetDataCommitTime
long GetDataCommitTime(long viewID, long dataID, char* sTime) GetDataCommitTime函数读实时数据视图中数据的提交时间。
参数
viewID (读)实时数据视图标识。
dataID (读) TAG点参数数据标识。
sTime (写)数据的提交时间,时间格式为“YYYY:MM:DD-HH:MM:SS”,意义为“年:月:日-时:分:秒”。
返回值:
指示函数执行状态:
不小于1的整数值函数执行成功;
小于1的整数值函数执行失败;
注:(函数执行失败原因可根据返回值参阅附录A)
参见 GetDataID
GetDataExist
long GetDataExist(long viewID, long dataID)
GetDataExist函数检查实时数据视图中的TAG点参数在数据库中是否存在。
参数
viewID (读)实时数据视图标识。
dataID (读) TAG点参数数据标识。
返回值:
不小于1的整数值实时数据视图中的TAG点参数在数据库中
存在;
小于1的整数值实时数据视图中的TAG点参数在数据库中不存
在;
GetDataID
long GetDataID(long viewID, char* dataDesc) ;
GetDataID函数读实时数据视图中的数据标识。
参数
viewID (读)实时数据视图标识。
dataDesc (读) 视图中存在的TAG点参数名称。
返回值:
指示TAG点参数的数据标识或函数执行状态
不小于0的整数值TAG点参数的数据标识;
小于0的整数值函数执行失败;
注:(函数执行失败原因可根据返回值参阅附录A)
GetDataInt
long GetDataInt(long viewID, long dataID, long& dat)
GetDataInt函数读实时数据视图中的整型数据。
参数
viewID (读)实时数据视图标识。
dataID (读) TAG点参数数据标识。
dat (写)TAG点参数整型数据值。
返回值:
指示函数执行状态:
不小于1的整数值函数执行成功;
小于1的整数值函数执行失败;
注:(函数执行失败原因可根据返回值参阅附录A)
参见 GetDataID
GetDataModifyFlag
long GetDataModifyFlag(long viewID, long dataID)
GetDataModifyFlag函数读实时数据视图中数据的修改标志,检测数据是否被修改。
参数
viewID (读)实时数据视图标识。
dataID (读) TAG点参数数据标识。
返回值:
1:数据被修改;
0:数据未被修改;
小于0的整数值:函数执行失败;
注:(函数执行失败原因可根据返回值参阅附录A)
参见 GetDataID
GetDataModifyTime
long GetDataModifyTime(long viewID, long dataID, char* sTime) GetDataModifyTime函数读实时数据视图中数据的修改时间。
参数
viewID (读)实时数据视图标识。
dataID (读) TAG点参数数据标识。
sTime (写)数据的修改时间,时间格式为“YYYY:MM:DD-HH:MM:SS”,意义为“年:月:日-时:分:秒”。
返回值:
指示函数执行状态:
不小于1的整数值函数执行成功;
小于1的整数值函数执行失败;
注:(函数执行失败原因可根据返回值参阅附录A)
参见 GetDataID
GetDataReal
long GetDataReal(long viewID, long dataID, double& dat)
GetDataReal函数读实时数据视图中的实型数据。
参数
viewID (读)实时数据视图标识。
dataID (读) TAG点参数数据标识。
dat (写)TAG点参数实型数据值。
返回值:
指示函数执行状态:
不小于1的整数值函数执行成功;
小于1的整数值函数执行失败;
注:(函数执行失败原因可根据返回值参阅附录A)
参见 GetDataID
GetDataStatus
long GetDataStatus(long viewID, long dataID)
GetDataStatus函数读实时数据视图中数据的状态。
参数
viewID (读)实时数据视图标识。
dataID (读) TAG点参数数据标识。
返回值:
实时数据视图中数据的状态。
参见 GetDataID
GetDataStr
long GetDataStr(long viewID, long dataID, char* dat, long length) GetDataStr函数读实时数据视图中的字符型数据。
参数
viewID (读)实时数据视图标识。
dataID (读) TAG点参数数据标识。
dat (写)TAG点参数字符型数据值。
length (读) TAG点参数字符型数据值长度。
返回值:
指示函数执行状态:
不小于1的整数值函数执行成功;
小于1的整数值函数执行失败;
注:(函数执行失败原因可根据返回值参阅附录A)
参见 GetDataID
GetDataStrLength
long GetDataStrLength(long viewID, long dataID)
GetDataStrLength函数读实时数据视图中的字符型数据长度(数据字节数)。参数
viewID (读)实时数据视图标识。
dataID (读) TAG点参数数据标识。
返回值:
指示字符型数据长度或函数执行状态;
不小于0的整数值字符型数据长度;
小于0的整数值函数执行失败;
注:(函数执行失败原因可根据返回值参阅附录A)
参见 GetDataID
GetDataTagCommitFlag
long GetDataTagCommitFlag(long viewID, char* tagName)
GetDataTagCommitFlag函数读实时数据视图中数据的提交标志,检测数据是否被提交。
参数
viewID (读)实时数据视图标识。
tagName (读) 视图中的一个TAG点参数的名称,字符串指针。格式为: <点名>.<参数名>.<细目名>。
返回值:
1:数据被提交;
0:数据未被提交;
小于0的整数值:函数执行失败;
注:(函数执行失败原因可根据返回值参阅附录A)
GetDataTagCommitStatus
long GetDataTagCommitStatus(long viewID, char* tagName, long& commitStatus)
GetDataTagCommiStatus函数读实时数据视图中数据向实时数据库中提交后的状态,检测数据是否被提交到实时数据库中。
参数
viewID (读)实时数据视图标识。
tagName (读) 视图中的一个TAG点参数的名称,字符串指针。格式为: <点名>.<参数名>.<细目名>。
commitStatus(写) 实时数据视图中数据向实时数据库中提交后的状态。可能的状态值及其意义如下:
Data_Success 1 数据成功提交
Data_NotChange 2 成功提交与前一值相同的数据
Data_SourceError -5 由于数据源错误提交失败
Data_UserLevelError -6 由于用户级别错误提交失败
Data_TagStateError -7 由于点状态错误提交失败
Data_ReadOnly -8 由于数据源只读提交失败
Data_HighLimit -9 发生超高限错误提交失败
Data_LowLimit -10 发生超低限错误提交失败
Data_OutputDisable -21 由于输出禁止发生输出失败(数据写入数据库但不能向外设输出)
Data_OutputHighLimit -22 由于输出超高限发生输出失败(数据写入数据库但不能向外设输出)
Data_OutputLowLimit -23 由于输出超低限发生输出失败(数据写入数据库但不能向外设输出)
Data_OutputModeError -25 由于输出方式错误发生输出失败(数据写入数据库但不能向外设输出)
Data_OutputStateError -26 由于输出状态错误发生输出失败(数据写入数据库但不能向外设输出)
返回值:
指示函数执行状态:
不小于1的整数值函数执行成功;
小于1的整数值函数执行失败;
注:(函数执行失败原因可根据返回值参阅附录A)
GetDataTagCommitTime
long GetDataTagCommitTime(long viewID, char* tagName, char* sTime) GetDataTagCommitTime函数读实时数据视图中数据的提交时间。
参数
viewID (读)实时数据视图标识。
tagName (读) 视图中的一个TAG点参数的名称,字符串指针。格式为: <点名>.<参数名>.<细目名>。
sTime (写)数据的提交时间,时间格式为“YYYY:MM:DD-HH:MM:SS”,意义为“年:月:日-时:分:秒”。
返回值:
指示函数执行状态:
不小于1的整数值函数执行成功;
小于1的整数值函数执行失败;
注:(函数执行失败原因可根据返回值参阅附录A)
GetDataTagExist
long GetDataTagExist(long viewID,char* tagName)
GetDataTagExist函数检查实时数据视图中的TAG点参数在数据库中是否存在。
参数
viewID (读)实时数据视图标识。
tagName (读) 视图中的一个TAG点参数的名称,字符串指针。格式为: <点名>.<参数名>.<细目名>。
返回值:
不小于1的整数值实时数据视图中的TAG点参数在数据库中
存在;
小于1的整数值实时数据视图中的TAG点参数在数据库中不存
在;
GetDataTagInt
long GetDataTagInt(long viewID, char* tagName, long& dat) GetDataTagInt函数读实时数据视图中的整型数据。
参数
viewID (读)实时数据视图标识。
tagName (读) 视图中的一个TAG点参数的名称,字符串指针。格式为: <点名>.<参数名>.<细目名>。
dat (写)TAG点参数整型数据值。
返回值:
指示函数执行状态:
不小于1的整数值函数执行成功;
小于1的整数值函数执行失败;
注:(函数执行失败原因可根据返回值参阅附录A)
GetDataTagModifyFlag
long GetDataTagModifyFlag(long viewID, char* tagName)
GetDataTagModifyFlag函数读实时数据视图中数据的修改标志,检测数据是否被修改。
参数
viewID (读)实时数据视图标识。
tagName (读) 视图中的一个TAG点参数的名称,字符串指针。格式为: <点名>.<参数名>.<细目名>。
返回值:
1:数据被修改;
0:数据未被修改;
小于0的整数值:函数执行失败;
注:(函数执行失败原因可根据返回值参阅附录A)
GetDataTagModifyTime
long GetDataTagModifyTime(long viewID, char* tagName, char* sTime) GetDataTagModifyTime函数读实时数据视图中数据的修改时间。
参数
viewID (读)实时数据视图标识。
tagName (读) 视图中的一个TAG点参数的名称,字符串指针。格式为: <点名>.<参数名>.<细目名>。
sTime (写)数据的修改时间,时间格式为“YYYY:MM:DD-HH:MM:SS”,意义为“年:月:日-时:分:秒”。
返回值:
指示函数执行状态:
不小于1的整数值函数执行成功;
小于1的整数值函数执行失败;
注:(函数执行失败原因可根据返回值参阅附录A)
GetDataTagReal
long GetDataTagReal(long viewID, char* tagName, double& dat) GetDataTagReal函数读实时数据视图中的实型数据。
参数
viewID (读)实时数据视图标识。
tagName (读) 视图中的一个TAG点参数的名称,字符串指针。格式为: <点名>.<参数名>.<细目名>。
dat (写)TAG点参数实型数据值。
返回值:
指示函数执行状态:
不小于1的整数值函数执行成功;
小于1的整数值函数执行失败;
注:(函数执行失败原因可根据返回值参阅附录A)
GetDataTagStatus
long GetDataTagStatus(long viewID, char* tagName)
GetDataTagStatus函数读实时数据视图中数据的状态。
参数
viewID (读)实时数据视图标识。
tagName (读) 视图中的一个TAG点参数的名称,字符串指针。格式为: <点名>.<参数名>.<细目名>。
返回值:
实时数据视图中数据的状态。
GetDataTagStr
long GetDataTagStr(long viewID, char* tagName, char* dat, long length) GetDataTagStr函数读实时数据视图中的字符型数据。
参数
viewID (读)实时数据视图标识。
tagName (读) 视图中的一个TAG点参数的名称,字符串指针。格式为: <点名>.<参数名>.<细目名>。
dat (写)TAG点参数字符型数据值。
length (读) TAG点参数字符型数据值长度。
返回值:
指示函数执行状态:
不小于1的整数值函数执行成功;
小于1的整数值函数执行失败;
注:(函数执行失败原因可根据返回值参阅附录A)GetDataTagStrLength
long GetDataTagStrLength(long viewID, char* tagName)
GetDataTagStrLength函数读实时数据视图中的字符型数据长度(数据字节数)。
参数
viewID (读)实时数据视图标识。
tagName (读) 视图中的一个TAG点参数的名称,字符串指针。格式为: <点名>.<参数名>.<细目名>。
返回值:
指示字符型数据长度或函数执行状态;
不小于0的整数值字符型数据长度;
小于0的整数值函数执行失败;
注:(函数执行失败原因可根据返回值参阅附录A)
GetDataTagType
long GetDataTagType(long viewID, char* tagName)
GetDataTagType函数读实时数据视图中数据的数据类型。
参数
viewID (读)实时数据视图标识。
tagName (读) 视图中的一个TAG点参数的名称,字符串指针。格式为: <点名>.<参数名>.<细目名>。
返回值:
实时数据视图中数据的数据类型,数据类型分别为:
DATA_TYPE_REAL 实型;
DATA_TYPE_INTEGER 整型;
DATA_TYPE_STRING 字符型。
返回小于1的整数值表示函数执行失败。
注:(函数执行失败原因可根据返回值参阅附录A)
GetDataTagUpdateFlag
long GetDataTagUpdateFlag(long viewID, char* tagName)
GetDataTagUpdateFlag函数读实时数据视图中数据的更新标志,检测数据是否被实时数据平台数据库中的数据更新。
参数
viewID (读)实时数据视图标识。
tagName (读) 视图中的一个TAG点参数的名称,字符串指针。格式为: <点名>.<参数名>.<细目名>。
返回值:
1:数据被更新;
0:数据未被更新;
小于0的整数值:函数执行失败;
注:(函数执行失败原因可根据返回值参阅附录A)GetDataTagUpdateTime
long GetDataTagUpdateTime(long viewID, char* tagName, char* sTime) ;
GetDataTagUpdateTime函数读实时数据视图中数据的更新时间。
参数
viewID (读)实时数据视图标识。
tagName (读) 视图中的一个TAG点参数的名称,字符串指针。格式为: <点名>.<参数名>.<细目名>。
sTime (写)数据的更新时间,时间格式为“YYYY:MM:DD-HH:MM:SS”,意义为“年:月:日-时:分:秒”。
返回值:
指示函数执行状态:
不小于1的整数值函数执行成功;
小于1的整数值函数执行失败;
注:(函数执行失败原因可根据返回值参阅附录A)
GetDataType
long GetDataType(long viewID, long dataID) ;
GetDataType函数读实时数据视图中数据的数据类型。
参数
viewID (读)实时数据视图标识。
dataID (读) TAG点参数数据标识。
返回值:
实时数据视图中数据的数据类型,数据类型分别为:
DATA_TYPE_REAL 实型;
DATA_TYPE_INTEGER 整型;
DATA_TYPE_STRING 字符型。
返回小于1的整数值表示函数执行失败。
注:(函数执行失败原因可根据返回值参阅附录A)
参见 GetDataID
GetDataUpdateFlag
long GetDataUpdateFlag(long viewID, long dataID)
GetDataUpdateFlag函数读实时数据视图中数据的更新标志,检测数据是否被实时数据平台数据库中的数据更新。
参数
viewID (读)实时数据视图标识。
dataID (读) TAG点参数数据标识。
返回值:
1:数据被更新;
0:数据未被更新;
小于0的整数值:函数执行失败;
注:(函数执行失败原因可根据返回值参阅附录A)
参见 GetDataID
GetDataUpdateTime