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

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