HAP 易语言 SDK 文档

概述

本 SDK 文档提供了 HAP 易语言模块中可用的子程序、类型和枚举的详细说明。
为每个 API 子程序提供了详细的参数和返回值说明，方便用户理解每个参数的含义和使用方法。

枚举

HAP_用户信息类型

用于指定要获取的用户信息类型的枚举：

API 子程序

HAP_初始化验证

功能
初始化客户端连接信息。
参数
- IP: 服务器的 IP 地址或域名
- 端口: 服务器端口号
- 主版本号: 客户端当前主版本号
- 次版本号: 客户端当前次版本号
- 修订版本号: 客户端当前修订版本号
- 构建版本号: 客户端当前构建版本号
返回值
成功时返回真，失败时返回假

HAP_许可证登录

功能
使用提供的许可证登录服务器。
参数
- 许可证: 用户的许可证
返回值
成功时返回真，失败时返回假
错误代码
调用失败时可通过HAP_取最后错误获取详细错误码

HAP_心跳

功能
对服务端进行心跳连接，确保授权合法化。
参数
无
返回值
成功时返回 真，失败时返回 假
注解
调用失败时可通过HAP_取最后错误获取详细错误信息

HAP_合法性校验

功能
检查当前登录会话的完整性和合法性。
参数
无
返回值
成功时返回 真，失败时返回 假
注解
在登录成功后可以使用该子程序进行安全性合法性检测该子程序将确保用户已成功登录，并且许可证仍在有效期内。如果未发现非法情况（如许可证到期或非法篡改），子程序将返回真，表示会话合法且安全；否则返回假

安全提示

此函数可在登录成功后，在对性能要求不高的业务函数中调用。它会自动检测授权的合法性及安全性，通过将验证逻辑分散到用户代码的各个功能点，增加验证系统与用户代码的耦合度，从而有效提升破解难度。

HAP_云函数

功能
在服务器插件模块中执行云端函数。
参数
- 命令: 指令字符串，用于指定要执行的操作
返回值
成功时返回接收信息内容，失败时返回空字节集
注解
服务端未配置插件模块时不会返回有效数据，其他错误可通过HAP_取最后错误获取详细错误信息

HAP_取最后错误

功能
返回 SDK 的最后一个错误代码。
参数
无
返回值
返回上次操作的错误代码
注解
此子程序可在任何 API 调用失败后使用，以获取详细的错误信息

HAP_取用户信息_文本型

功能
根据指定的类型获取文本用户信息
参数
- type: 指定要获取的用户信息类型
  - #HAP_用户信息类型_许可证 = 许可证（文本）
  - #HAP_用户信息类型_管理员 = 管理员（文本）
  - #HAP_用户信息类型_许可证备注 = 备注（文本）
返回值
成功返回文本，失败返回空

HAP_取用户信息_数值型

功能
根据指定的类型获取数值类型的用户信息
参数
- type: 指定要获取的用户信息类型
  - #HAP_用户信息类型_剩余秒数 = 剩余秒数（长整数）
  - #HAP_用户信息类型_剩余点数 = 剩余点数（整数）
返回值
成功返回数值，失败 0

HAP_取用户信息_字节集

功能
根据指定的类型获取用户信息原始数据字节集（可用于处理编码等其他问题）
参数
- type: 指定要获取的用户信息类型
  - #HAP_用户信息类型_许可证 = 许可证（文本）
  - #HAP_用户信息类型_管理员 = 管理员（文本）
  - #HAP_用户信息类型_许可证备注 = 备注（文本）
  - #HAP_用户信息类型_剩余秒数 = 剩余秒数（长整数）
  - #HAP_用户信息类型_剩余点数 = 剩余点数（整数）
返回值
成功返回字节集，失败返回空字节集

HAP_取版本信息_公告

功能
获取初始化时填写的版本号在管理系统中设置的公告信息。
参数
无
返回值
成功返回公告文本，失败返回空文本
注解
数据实时从服务端获取，可用于客户端获取版本公告、更新提示等信息。

HAP_安全结束

功能
主动终止当前进程。用于心跳异常、云函数异常、许可证到期等不安全场景下，确保进程被强制结束，防止被 Hook 或拦截导致无法退出。
参数
- 退出代码: 进程退出码，可空，默认为0
返回值
无
注解
推荐在检测到安全风险时调用，确保进程无法被非法手段阻止退出

警告

此子程序会直接终止进程，请仅在检测到安全风险（心跳失败、合法性校验失败等）时调用。