智能一卡通管理系统概述.docxVIP

  • 0
  • 0
  • 约1.3万字
  • 约 17页
  • 2023-08-03 发布于浙江
  • 举报
平台开发手册 (客户端部分) 非常感谢选择本公司产品,我们将竭诚为您提供最好的服务。 本手册内容将不定期更新,恕不另行通知;更新内容将在版本更新信息中给出。 如您对手册中的内容有疑惑或者有好的建议,请通过技术支持联系我们。 我们的进步需要您的宝贵意见。 简介 前提 当您阅读该开发手册时,同时应该拿到以下内容: . . 及其依赖的其他 . ,为平台(部分)的测试,包括源代码及可执行程序。 版本信息 版本号 日期 变更说明 发布 接口定义 初始化反初始化接口定义 初始化接口 接口名称: (); 接口描述: 初始化平台 参数说明: 无 返回值: 成功返回,错误时返回,通过查看错误码 备注: 初始化接口只需调用一次,在调用任何接口前,必须调用 完成初始化工作 反初始化接口 接口名称: (); 接口描述: 反初始化平台 参数说明: 无 返回值: 成功返回,错误时返回,通过查看错误码 备注: 释放资源,全局只调用一次 用户接口定义 登录接口 接口名称: ( * , , * , * , , ); 接口描述: 用户登录到指定平台 参数说明: 参数名 输入输出 描述 [] 中心管理服务器地址,(例“”) [] 中心管理服务器端口。(例) [] 用户名 (例 ) [] 用户密码(例) [] 登录类型。(为预留参数,默认为) [] 服务器端口,默认 返回值:成功返回一个大于的会话句柄,错误时返回,通过查看错误码 备注:无 登出接口 接口名称: ( ); 接口描述: 用户登出接口 参数说明: 参数名 输入输出 描述 [] 返回的句柄 返回值: 成功返回,错误时返回,通过查看错误码 备注: 无 组织资源接口定义 获取控制中心信息接口 接口名称: ( , , * , * ); 接口描述: 获取控制中心列表信息 参数说明: 参数名 输入输出 描述 [] 返回的句柄 [] 需要获取的中心个数 [][] 存放控制单元的缓冲区,由调用者分配 [] 输出资源数目,当缓冲区为时,的值为资源的总的数目,其他情况下为成功输出资源的数目 返回值: 成功返回,错误时返回,通过查看错误码 备注: 无 获取区域信息接口 接口名称: ( , , * , * ); 接口描述: 获取区域信息 参数说明: 参数名 输入输出 描述 [] 返回的句柄 [] 需要获取的资源个数 [][] 存放区域的缓冲区,由调用者分配 [] 输出资源数目,当缓冲区为时,的值为资源的总的数目,其他情况下为成功输出资源的数目 返回值: 成功返回,错误时返回,通过查看错误码 备注: 无 查询权限接口定义 查询权限接口 接口名称: ( , , , ); 接口描述: 检查资源权限 参数说明: 参数名 输入输出 描述 [] 返回的句柄 [] 权限元素类型,见 [] 权限掩码,见 [] 元素 返回值: 有权限时返回,无权限返回 备注: 无 报警事件订阅接口定义 订阅报警事件接口 接口名称: ( , , * ); 接口描述: 订阅报警、事件 参数说明: 参数名 输入输出 描述 [] 返回的句柄 [] 报警、事件接收回调函数指针 [] 用户数据 返回值: 调用成功, 调用失败,通过查看错误码 备注: 无 取消订阅接口 接口名称: ( ); 接口描述: 取消订阅事件 参数说明: 参数名 输入输出 描述 [] 返回的句柄 返回值: 调用成功, 调用失败,通过查看错误码 备注: 无 根据获取图片 接口名称: ( , * , ** , * ); 接口描述: 根据图片的获取图片信息,图片可以在订阅报警事件回调中获取 参数说明: 参数名 输入输出 描述 [] 返回的句柄 [] 图片 [] 图片数据 [] 图片长度 返回值: 调用成功, 调用失败,通过查看错误码 备注: 获取到图片后,需要调用释放内存 释放图片数据 接口名称: ( , ** ); 接口描述: 释放图片数据 参数说明: 参数名 输入输出 描述 [] 返回的句柄 [] 图片数据 返回值: 调用成功, 调用失败,通过查看错误码 备注: 无 订阅状态接口定义 订阅状态接口 接口名称: ( , , * ); 接口描述: 订阅状态接口,包括设备在线状态、门禁状态等

文档评论(0)

1亿VIP精品文档

相关文档