海迅实时数据库HS-SDK
用户手册
目录
目录. (2)
1.引言 (4)
1.1.编写目的 (4)
1.2适用范围 (4)
2. 接口分类 (4)
3. 接口详细说明 (4)
3.1数据库服务连接、状态查询接口 (4)
3.1.1 数据库服务(HSServer类) (4)
3.1.2 名字服务集合(HSNameServers类) (5)
3.1.3 名字服务对象(HSNameServer类) (6)
3.2数据库测点提交、查询接口 (6)
3.2.1测点集合(HSPoints类) (6)
3.2.2测点对象(HSPoint类) (7)
3.2.3测点组集合(HSGroups类) (8)
3.2.4测点组对象(HSGroup类) (8)
3.2.5批量测点集合(HSPointList类) (8)
3.2.6 数据名称-值集合(HSNameValues类) (9)
3.2.7数据名称-值对象(HSNameValue类) (9)
3.3数据提交、查询接口 (9)
3.3.1数据值集合(HSData类) (9)
3.3.2测点数据值集合(HSValues类) (10)
3.3.3测点数据值对象(HSValue类) (11)
3.3.4批量测点数据值集合(HSListData类) (11)
3.3.5测点-值集合(HSPointValues类) (12)
3.3.6测点-值对象(HSPointValue类) (12)
3.4数据库用户、权限管理接口 (12)
3.4.1用户集合(HSUsers类) (12)
3.4.3角色集合(HSRoles类) (13)
3.4.4角色对象(HSRole类) (13)
3.5测点模糊查询对话框 (14)
3.5.1测点模糊查询窗体(HSDlgTestShow类) (14)
3.6枚举集接口 (18)
3.6.1枚举集集合(HSEnumrations类) (18)
3.6.2枚举集对象(HSEnumration类) (18)
1.引言
1.1.编写目的
将HS-API封装成基于COM组件的HS-SDK，以方便对海迅数据库API接口二次开发使用。

1.2适用范围
适用于海迅数据库百万点系列版本。

2. 接口分类
1.数据库服务连接、状态接口。

2.数据库测点提交、查询接口。

3.数据提交、查询接口。

4.数据库用户、权限管理接口。

5.测点模糊查询窗体。

6.枚举集接口。

3. 接口详细说明
3.1 数据库服务连接、状态查询接口
3.1.1 数据库服务(HSServer类)
该类代表HighSoon数据库实例对象，返回数据库对应的实例集合。

3.1.2 名字服务集合(HSNameServers类)
3.1.3 名字服务对象(HSNameServer类)
该类代表HighSoon数据库的HSServer对象，包含对应命名服务器中的所有数据库实例，并具有连接、断开命名服务器方法
3.2数据库测点提交、查询接口
3.2.1测点集合(HSPoints类)
该类代表HighSoon数据库测点对象集合，默认属性返回HSPoint对象，并具有添加测点、删除测点、查询测点、重命名测点方法。

3.2.2测点对象(HSPoint类)
该类代表HighSoon的测点对象，有一个属性返回HSData对象，另有属性返回HSPointAtrriubtes 集合对象。

3.2.3测点组集合(HSGroups类)
该类代表HighSoon数据库测点组集合，默认属性返回HSGroup对象。

3.2.4测点组对象(HSGroup类)
该类代表HighSoon数据库测点组对象。

3.2.5批量测点集合(HSPointList类)
该类代表HighSoon数据库批量测点集合。

3.2.6 数据名称-值集合(HSNameValues类)
该类是通用数据类型集合，代表HighSoon数据库名称与值的集合，
3.2.7数据名称-值对象(HSNameValue类)
该类代表HighSoon数据库名称与值的对象。

3.3 数据提交、查询接口
用于测点实时、历史数据的交互，包含各种数据查询、数据提交、数据删除方法。

3.3.1数据值集合(HSData类)
3.3.2测点数据值集合(HSValues类)
3.3.3测点数据值对象(HSValue类)
3.3.4批量测点数据值集合(HSListData类)
该类是批量测点数据集合类，与HSPointList类相对应。

3.3.5测点-值集合(HSPointValues类)
该类代表HighSoon数据库测点-值集合，其中测点与值一一对应。

3.3.6测点-值对象(HSPointValue类)
该类代表HighSoon数据库测点-值对象。

3.4数据库用户、权限管理接口
用于数据库访问权限控制，包括用户添加、权限分配等。

3.4.1用户集合(HSUsers类)
3.4.2用户对象(HSUser类)
3.4.3角色集合(HSRoles类)
3.4.4角色对象(HSRole类)
3.5测点模糊查询对话框
用于测点的模糊查询、搜索等功能。

3.5.1测点模糊查询窗体(HSDlgTestShow 类)
模糊查询初始界面如下图所示：
其中，HS 命名服务器列表是通过读取“C:\Windows ”路径下的文件“HSSDK.ini ”获取，数据库实例项跟随命名服务的变化动态响应，其下拉列表内容为命名服务器中所包含的数据库实例。

测点类型、测点名、测点组、测点描述是搜索条件，可根据需要进行相应设置，默认为空。

窗体下半部分为测点属性查询结果，其中显示，服务器、测点名称、测点描述三列内容。

左侧为搜索工具栏，包括模糊搜索、测点属性、测点最新值、重置、全选、确定和取消。

下面分别说明各主要按钮的功能：
一是模糊搜索按钮，当设置完测点类型、测点名、测点组等搜索项之后，点击搜索按钮，即可得到
当前搜索条件的查询结果，如下图所示：
二是“测点属性”和“测点值”按钮，在测点查询列表中，选择某些测点信息（一行或多行），然后点击“测点属性”按钮，如下图所示：
即出现测点属性窗体，该窗体包含所选测点的测点属性信息，如下图所示：
当点击“测点值”按钮，如下图所示：
即出现测点值窗体，该窗体包含所选定测点的当前最新值，如下图所示：
置”按钮时，模糊搜索中的所有查询条件信息和搜索结果被清除。

四是“确定”按钮，当模糊搜索列表中的测点信息被选中之后，点击“确定”按钮，被选中测点的属性信息作为返回值PointList返回主窗体。

3.6枚举集接口
该类代表HighSoon数据库枚举集对象集合，默认属性返回HSEnumration对象，并具有添加枚举集、删除枚举集、查询枚举集、更新枚举集方法。

3.6.1枚举集集合(HSEnumrations类)
3.6.2枚举集对象(HSEnumration类)
该类代表HighSoon的枚举集对象，有一个属性返回HSData对象，另有属性返回HSPointAtrriubtes集合对象。