智能一卡通管理系统6700平台SDKV00(CS客户端部分).docx

《智能一卡通管理系统6700平台SDKV00(CS客户端部分).docx》由会员分享，可在线阅读，更多相关《智能一卡通管理系统6700平台SDKV00(CS客户端部分).docx（50页珍藏版）》请在三一办公上搜索。

1、平台SDK开发手册 （CS部分） 平台SDK开发手册 （CS客户端部分）非常感谢选择本公司产品，我们将竭诚为您提供最好的服务。本手册内容将不定期更新，恕不另行通知；更新内容将在版本更新信息中给出。如您对手册中的内容有疑惑或者有好的建议，请通过技术支持联系我们。我们的进步需要您的宝贵意见。1. 简介1.1 前提当您阅读该开发手册时，同时应该拿到以下内容：1. PlatformSDK.h2. PlatformSDK.dll及其依赖的其他dll3. PlatSDK_Test，为平台SDK（CS部分）的测试demo，包括C+源代码及可执行程序。1.2 版本信息版本号日期变更说明1.0.02015-03

2、-23发布2. 接口定义2.1 初始化/反初始化接口定义2.1.1 初始化接口接口名称：int Plat_Init();接口描述：初始化平台SDK参数说明：无返回值：成功返回0，错误时返回-1，通过Plat_GetLastError()查看错误码备注：初始化接口只需调用一次，在调用任何接口前，必须调用 Plat_Init完成初始化工作2.1.2 反初始化接口接口名称：int Plat_UnInit();接口描述：反初始化平台SDK参数说明：无返回值：成功返回0，错误时返回-1，通过Plat_GetLastError()查看错误码备注：释放资源，全局只调用一次2.2 用户接口定义2.2.1 登录

3、接口接口名称：int Plat_LoginCMS(const char* cscmsIP, int icmsPort, const char* csUserName, const char* csPSW, int iLoginType = 0, int iMqPort = 61618);接口描述：用户登录到指定平台参数说明：参数名输入/输出描述cscmsIPin中心管理服务器地址，(例“172.7.150.2”)icmsPortin中心管理服务器端口。（例80）csUserNamein用户名 （例 admin）csPSWin用户密码（例admin）iLoginTypein登录类型。（为预留参数

4、，默认为0）iMqPortinMQ服务器端口，默认61618返回值：成功返回一个大于0的会话句柄，错误时返回-1，通过Plat_GetLastError()查看错误码备注：无2.2.2 登出接口接口名称：int Plat_LogoutCMS(int iUserHandle);接口描述：用户登出接口参数说明：参数名输入/输出描述iUserHandleinPlat_LoginCMS返回的句柄返回值：成功返回0，错误时返回-1，通过Plat_GetLastError()查看错误码备注：无2.3 组织资源接口定义2.3.1 获取控制中心信息接口接口名称：int Plat_GetAllControlCe

5、ll(int iUserHandle, int iNeedGetNum, PLAT_CONTROLCELLINFO* pCellBuffer, int* pOutputNum);接口描述：获取控制中心列表信息参数说明：参数名输入/输出描述iUserHandleinPlat_LoginCMS返回的句柄iNeedGetNumin需要获取的中心个数pCellBufferinout存放控制单元的缓冲区，由调用者分配pOutputNumout输出资源数目，当缓冲区为NULL时，pOutputNum的值为资源的总的数目，其他情况下pOutputNum为成功输出资源的数目返回值：成功返回0，错误时返回-1，

6、通过Plat_GetLastError()查看错误码备注：无2.3.2 获取区域信息接口接口名称：int Plat_GetAllRegion (int iUserHandle, int iNeedGetNum, PLAT_REGIONINFO* pRegionBuffer, int* pOutputNum);接口描述：获取区域信息参数说明：参数名输入/输出描述iUserHandleinPlat_LoginCMS返回的句柄iNeedGetNumin需要获取的资源个数pRegionBufferinout存放区域的缓冲区，由调用者分配pOutputNumout输出资源数目，当缓冲区为NULL时，pO

7、utputNum的值为资源的总的数目，其他情况下pOutputNum为成功输出资源的数目返回值：成功返回0，错误时返回-1，通过Plat_GetLastError()查看错误码备注：无2.4 查询权限接口定义2.4.1 查询权限接口接口名称：int Plat_CheckRight(int iUserHandle,int iObjectType,int iRightTpye, int iObjectID);接口描述：检查资源权限参数说明：参数名输入/输出描述iUserHandleinPlat_LoginCMS返回的句柄iObjectTypein权限元素类型,见PLAT_PRLOBJTYPE_*i

8、RightTpyein权限掩码,见PLAT_PRLMASK_*iObjectIDin元素ID返回值：有权限时返回0，无权限返回-1备注：无2.5 报警/事件订阅接口定义2.5.1 订阅报警/事件接口接口名称：int Plat_SubscribeInfo(int iUserHandle,EventSubscribeCallback fSubscribeCallback,void* pUser);接口描述：订阅报警、事件参数说明：参数名输入/输出描述iUserHandleinPlat_LoginCMS返回的句柄fSubscribeCallbackin报警、事件接收回调函数指针pUserin用户数据

9、返回值：0 调用成功, -1 调用失败，通过Plat_GetLastError()查看错误码备注：无2.5.2 取消订阅接口接口名称：int Plat_UnSubscribeInfo(int iUserHandle);接口描述：取消订阅事件参数说明：参数名输入/输出描述iUserHandleinPlat_LoginCMS返回的句柄返回值：0 调用成功, -1 调用失败，通过Plat_GetLastError()查看错误码备注：无2.5.3 根据URL获取图片接口名称：int Plat_GetPicDataByURL(int iUserHandle, const char* pURL, char

10、* pPicData, int* pPicLen);接口描述：根据图片的URL获取图片信息，图片URL可以在订阅报警事件回调中获取参数说明：参数名输入/输出描述iUserHandleinPlat_LoginCMS返回的句柄pURLin图片URL pPicDataout图片数据pPicLenout图片长度返回值：0 调用成功, -1 调用失败，通过Plat_GetLastError()查看错误码备注：获取到图片后，需要调用Plat_FreePicData释放内存2.5.4 释放图片数据接口名称：int Plat_FreePicData(int iUserHandle,char* pPicData

11、);接口描述：释放图片数据参数说明：参数名输入/输出描述iUserHandleinPlat_LoginCMS返回的句柄pPicDatain图片数据返回值：0 调用成功, -1 调用失败，通过Plat_GetLastError()查看错误码备注：无2.6 订阅状态接口定义2.6.1 订阅状态接口接口名称：int Plat_SubscribeState (int iUserHandle,StateCallback fSubscribeCallback,void* pUser);接口描述：订阅状态接口，包括设备在线状态、门禁状态等参数说明：参数名输入/输出描述iUserHandleinPlat_Lo

12、ginCMS返回的句柄fSubscribeCallbackin资源状态接收回调函数指针pUserin用户数据返回值：0 调用成功, -1 调用失败，通过Plat_GetLastError()查看错误码备注：无2.6.2 取消订阅接口接口名称：int Plat_UnSubscribeState (int iUserHandle);接口描述：取消订阅接口参数说明：参数名输入/输出描述iUserHandleinPlat_LoginCMS返回的句柄返回值：0 调用成功, -1 调用失败，通过Plat_GetLastError()查看错误码备注：无2.7 报警接口定义2.7.1 获取设备主机信息接口名称

13、：int Plat_VSS_GetDeviceHostInfo(int iUserHandle, int iType, int iNeedGetNum, LPPLAT_VSS_DEVICEHOST pOutDevHostInfo, int* pOutputNum);接口描述：获取设备主机信息参数说明：参数名输入/输出描述iUserHandleinPlat_LoginCMS返回的句柄iTypein报警设备类型，报警主机：PLAT_DEVICE_ALARM_HOST，消防主机：PLAT_DEVICE_FIRE_HOST，动环主机：PLAT_DEVICE_SENSOR_HOST，停车场管理主机：PL

14、AT_DEVICE_PARK_HOST，巡查主机：PLAT_DEVICE_PATROLiNeedGetNumin需要获取的数目pOutDevHostInfoinout报警设备信息输出缓冲区pOutputNumout输出资源数目，当pOutDevHostInfo为NULL时，pOutputNum保存的值为资源的总的数目，其他情况下pOutputNum为成功输出资源的数目。返回值：0 调用成功, -1 调用失败，通过Plat_GetLastError()查看错误码备注：无2.7.2 获取设备通道信息接口名称：int Plat_VSS_GetDevChnlInfo (int iUserHandle,

15、 int iType, int iNeedGetNum,LPPLAT_VSS_DEVICECHANNEL pOutDevChnlInfo,int* pOutputNum);接口描述：获取设备通道信息参数说明：参数名输入/输出描述iUserHandleinPlat_LoginCMS返回的句柄iTypein设备通道类型，报警IO：PLAT_RES_IO，防区：PLAT_RES_DEFENCE_AREA，消防点：PLAT_RES_FIRE_POINT，巡查点：PLAT_RES_PATROL_POINTiNeedGetNumin需要获取的数目pOutDevChnlInfoinout报警设备通道信息输出

16、缓冲区pOutputNumout输出资源数目，当pOutDevHostInfo为NULL时，pOutputNum保存的值为资源的总的数目，其他情况下pOutputNum为成功输出资源的数目。返回值：0 调用成功, -1 调用失败，通过Plat_GetLastError()查看错误码备注：无2.7.3 报警控制接口名称：int Plat_VSS_AlarmControl (int iUserHandle, int iResourceID, int iCommand);接口描述：获取设备通道信息参数说明：参数名输入/输出描述iUserHandleinPlat_LoginCMS返回的句柄iResou

17、rceIDin资源IDiCommandin控制命令，报警输出关闭：PLAT_CMD_IOCLOSE，报警输出打开：PLAT_CMD_IOOPEN；报警主机撤防：PLAT_CMD_ALMHOST_DISDEFENCE，报警主机布防：PLAT_CMD_ALMHOST_DEFENCE；防区旁路恢复：PLAT_CMD_AREA_UNBYPASS，防区旁路：PLAT_CMD_AREA_BYPASS返回值：0 调用成功, -1 调用失败，通过Plat_GetLastError()查看错误码备注：无2.7.4 获取报警状态接口名称：int Plat_VSS_GetAlarmState(int iUserHa

18、ndle, int iType, int* iRtnState);接口描述：获取设备通道信息参数说明：参数名输入/输出描述iUserHandleinPlat_LoginCMS返回的句柄iResourceIDin资源IDiTypein资源类型：报警主机：PLAT_DEVICE_ALARM_HOST，报警IO：PLAT_RES_IO，防区：PLAT_RES_DEFENCE_AREAiRtnStateout返回资源的状态返回值：0 调用成功, -1 调用失败，通过Plat_GetLastError()查看错误码备注：无2.8 一卡通接口定义2.8.1 根据卡号获取人员信息接口名称：int Plat_

19、ACS_GetPersonInfo (int iUserHandle, const char* csCardNo, LPPLAT_ACS_PERSONINFO pOutPersonInfo);接口描述：根据卡号获取人员信息（获取一个人员信息）参数说明：参数名输入/输出描述iUserHandleinPlat_LoginCMS返回的句柄csCardNoin卡号pOutPersonInfoin单个人员信息输出缓冲区返回值：0 调用成功, -1 调用失败，通过Plat_GetLastError()查看错误码备注：无2.8.2 获取所有人员信息接口名称：int Plat_ACS_GetAllPerson

20、Info (int iUserHandle, int iNeedGetNum, LPPLAT_ACS_PERSONINFO pOutPersonInfo,int* pOutputNum);接口描述：获取所有人员信息参数说明：参数名输入/输出描述iUserHandleinPlat_LoginCMS返回的句柄iNeedGetNumin需要获取的数目pOutPersonInfoinout需要获取的人员信息输出缓冲区pOutputNumout输出资源数目，当pOutPersonInfo为NULL时，pOutputNum的值为资源的总的数目，其他情况下pOutputNum为成功输出资源的数目。返回值：0

21、 调用成功, -1 调用失败，通过Plat_GetLastError()查看错误码备注：无2.8.3 获取所有卡片信息接口名称：int Plat_ACS_GetCardInfo (int iUserHandle, int iNeedGetNum, LPPLAT_ACS_CARDINFO pOutCardInfo, int* pOutputNum);接口描述：获取所有卡片信息参数说明：参数名输入/输出描述iUserHandleinPlat_LoginCMS返回的句柄iNeedGetNumin需要获取的数目pOutCardInfoinout需要获取的门禁点信息输出缓冲区pOutputNumout输

22、出资源数目，当pOutCardInfo为NULL时，pOutputNum的值为资源的总的数目，其他情况下pOutputNum为成功输出资源的数目。返回值：0 调用成功, -1 调用失败，通过Plat_GetLastError()查看错误码备注：无2.8.4 获取部门信息接口名称：int Plat_ATT_GetAllDepartments (int iUserHandle, int iNeedGetNum, LPPLAT_ATT_DEPARTMENT pOutputInfo,int* pOutputNum);接口描述：获取所有部门信息参数说明：参数名输入/输出描述iUserHandleinPl

23、at_LoginCMS返回的句柄iNeedGetNumin需要获取的数目pOutputInfoinout需要获取的所有部门输出缓冲区pOutputNumout输出资源数目，当pOutputInfo为NULL时，pOutputNum保存的值为资源的总的数目，其他情况下pOutputNum为成功输出资源的数目。返回值：0 调用成功, -1 调用失败，通过Plat_GetLastError()查看错误码备注：无2.9 门禁接口定义2.9.1 获取门禁设备接口接口名称：int Plat_ACS_GetACDeviceInfo (int iUserHandle, int iNeedGetNum, LPP

24、LAT_ACS_ACDEVICEINFO pOutACDeviceInfo,int* pOutputNum);接口描述：获取所有人员信息参数说明：参数名输入/输出描述iUserHandleinPlat_LoginCMS返回的句柄iNeedGetNumin需要获取的数目pOutACDeviceInfoinout需要获取的门禁设备信息输出缓冲区pOutputNumout输出资源数目，当pOutACDeviceInfo为NULL时，pOutputNum保存的值为资源的总的数目，其他情况下pOutputNum为成功输出资源的数目。返回值：0 调用成功, -1 调用失败，通过Plat_GetLastEr

25、ror()查看错误码备注：无2.9.2 获取门禁点接口接口名称：int Plat_ACS_GetACDoorInfo (int iUserHandle, int iNeedGetNum, LPPLAT_ACS_ACCESSDOORINFO pOutACDoorInfo,int* pOutputNum);接口描述：获取所有门禁点信息参数说明：参数名输入/输出描述iUserHandleinPlat_LoginCMS返回的句柄iNeedGetNumin需要获取的数目pOutACDoorInfoinout需要获取的门禁点信息输出缓冲区pOutputNumout输出资源数目，当pOutACDoorInf

26、o为NULL时，pOutputNum保存的值为资源的总的数目，其他情况下pOutputNum为成功输出资源的数目。返回值：0 调用成功, -1 调用失败，通过Plat_GetLastError()查看错误码备注：无2.9.3 门禁点控制接口接口名称：int Plat_ACS_ACDoorControl (int iUserHandle, int iACDoorID, int iCommand);接口描述：门禁点控制接口参数说明：参数名输入/输出描述iUserHandleinPlat_LoginCMS返回的句柄iACDoorIDin门禁点IDiCommandin控制命令，开门一次：PLAT_AC

27、S_CMD_OPEN，关门：PLAT_ACS_CMD_CLOSE, 常开：PLAT_ACS_CMD_RELEASE，常闭：PLAT_ACS_CMD_LOCK返回值：0 调用成功, -1 调用失败，通过Plat_GetLastError()查看错误码备注：无2.9.4 获取门禁点状态接口接口名称：int Plat_ACS_GetDoorState (int iUserHandle, int iACDoorID, int* iRtnState);接口描述：获取门禁点状态参数说明：参数名输入/输出描述iUserHandleinPlat_LoginCMS返回的句柄iACDoorIDin门禁点IDiRt

28、nStateout返回的状态值返回值：0 调用成功, -1 调用失败，通过Plat_GetLastError()查看错误码备注：无2.9.5 门禁设备参数配置接口接口名称：int Plat_ACS_SetDevConfig (int iUserHandle, int iACDevID, const char* szConfXml);接口描述：门禁设备参数配置参数说明：参数名输入/输出描述iUserHandleinPlat_LoginCMS返回的句柄iACDevIDin门禁设备IDszConfXmlout配置参数XML返回值：0 调用成功, -1 调用失败，通过Plat_GetLastError

29、()查看错误码备注：无2.10 考勤接口定义2.10.1 查询刷卡记录数目接口接口名称：int Plat_ATT_QueryClockRecord (int iUserHandle, LPPLAT_ATT_SEARCHCONDITION pCondition, int* pOutputNum);接口描述：查询刷卡记录数目参数说明：参数名输入/输出描述iUserHandleinPlat_LoginCMS返回的句柄pConditionin查询条件pOutputNumout输出资源数目返回值：0 调用成功, -1 调用失败，通过Plat_GetLastError()查看错误码备注：无2.10.2 获

30、取刷卡记录接口接口名称：int Plat_ATT_GetClockRecord (int iUserHandle, int iNeedGetNum,LPPLAT_ATT_CLOCKRECORD pOutputInfo, int* pOutputNum);接口描述：获取刷卡记录参数说明：参数名输入/输出描述iUserHandleinPlat_LoginCMS返回的句柄iNeedGetNumin需要获取的数目，Plat_ATT_QueryClockRecord接口中pOutputNum的值pOutputInfoin out查询结果输出缓冲区pOutputNumout输出数目返回值：0 调用成功,

31、-1 调用失败，通过Plat_GetLastError()查看错误码备注：无2.10.3 查询考勤结果接口接口名称：int Plat_ATT_QueryAttendResult (int iUserHandle, LPPLAT_ATT_SEARCHCONDITION pCondition, int* pOutputNum);接口描述：查询考勤结果参数说明：参数名输入/输出描述iUserHandleinPlat_LoginCMS返回的句柄pConditionin查询条件pOutputNumout输出数目返回值：0 调用成功, -1 调用失败，通过Plat_GetLastError()查看错误码备

32、注：无2.10.4 获取考勤结果接口接口名称：int Plat_ATT_GetAttendResult (int iUserHandle, int iNeedGetNum,LPPLAT_ATT_ATTENDRESULT pOutputInfo, int* pOutputNum);接口描述：获取考勤结果参数说明：参数名输入/输出描述iUserHandleinPlat_LoginCMS返回的句柄iNeedGetNumin需要获取的数目，Plat_ATT_QueryAttendResult接口中pOutputNum的值pOutputInfoin out查询结果输出缓冲区pOutputNumout输出

33、数目返回值：0 调用成功, -1 调用失败，通过Plat_GetLastError()查看错误码备注：无2.11 梯控接口定义2.11.1 获取梯控设备接口接口名称：int Plat_ECS_GetAllECDevices (int iUserHandle, int iNeedGetNum,LPPLAT_ECS_ECDEVICEINFO pOutputInfo, int* pOutputNum);接口描述：获取所有梯控设备信息参数说明：参数名输入/输出描述iUserHandleinPlat_LoginCMS返回的句柄iNeedGetNumin需要获取的数目pOutputInfoin out需要

34、获取的所有梯控设备输出缓冲区pOutputNumout输出资源数目，当pOutputInfo为NULL时，pOutputNum保存的值为资源的总的数目，其他情况下pOutputNum为成功输出资源的数目。返回值：0 调用成功, -1 调用失败，通过Plat_GetLastError()查看错误码备注：无2.12 巡查接口定义2.12.1 获取所有巡查计划接口接口名称：int Plat_OPS_GetAllPatrolPlan (int iUserHandle, int iNeedGetNum,LPPLAT_OPS_PATROLPLANINFO pOutputInfo, int* pOutput

35、Num);接口描述：获取所有巡查计划信息参数说明：参数名输入/输出描述iUserHandleinPlat_LoginCMS返回的句柄iNeedGetNumin需要获取的数目pOutputInfoin out需要获取的所有巡查计划信息输出缓冲区pOutputNumout输出资源数目，当pOutputInfo为NULL时，pOutputNum保存的值为资源的总的数目，其他情况下pOutputNum为成功输出资源的数目返回值：0 调用成功, -1 调用失败，通过Plat_GetLastError()查看错误码备注：无2.12.2 查询班次数目接口接口名称：int Plat_OPS_QuerySchd

36、lNum (int iUserHandle, _int64 lStartTime, _int64 lEndTime, int* pOutputNum);接口描述：查询班次数目参数说明：参数名输入/输出描述iUserHandleinPlat_LoginCMS返回的句柄lStartTimein开始时间lEndTimein结束时间pOutputNumout输出数目返回值：0 调用成功, -1 调用失败，通过Plat_GetLastError()查看错误码备注：无2.12.3 获取所有班次信息接口接口名称：int Plat_OPS_GetAllSchedulings (int iUserHandle,

37、 int iNeedGetNum, LPPLAT_OPS_SCHEDULINGINFO pOutputInfo, int* pOutputNum);接口描述：获取所有班次信息参数说明：参数名输入/输出描述iUserHandleinPlat_LoginCMS返回的句柄iNeedGetNumin需要获取的数目，Plat_OPS_QuerySchdlNum接口中pOutputNum的返回值pOutputInfoin out需要获取的所有巡查班次信息输出缓冲区pOutputNumout输出数目返回值：0 调用成功, -1 调用失败，通过Plat_GetLastError()查看错误码备注：无2.12.

38、4 获取所有巡查路线接口接口名称：int Plat_OPS_GetAllRoutes (int iUserHandle, int iNeedGetNum, LPPLAT_OPS_ROUTEINFO pOutputInfo, int* pOutputNum);接口描述：获取所有巡查路线参数说明：参数名输入/输出描述iUserHandleinPlat_LoginCMS返回的句柄iNeedGetNumin需要获取的数目pOutputInfoin out需要获取的所有巡查路线信息输出缓冲区pOutputNumout输出资源数目，当pOutputInfo为NULL时，pOutputNum保存的值为资源的总的数目，其他情况下pOutputNum为成功输出资源