搜索
平台SDK开发手册（CS部分）平台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-23发布平台SDK开发手册（CS部分）2.接口定义2.1初始化/反初始化接口定义2.1.1初始化接口接口名称：intPlat_Init();接口描述：初始化平台SDK参数说明：无返回值：成功返回0，错误时返回-1，通过Plat_GetLastError()查看错误码备注：初始化接口只需调用一次，在调用任何接口前，必须调用Plat_Init完成初始化工作2.1.2反初始化接口接口名称：intPlat_UnInit();接口描述：反初始化平台SDK参数说明：无返回值：成功返回0，错误时返回-1，通过Plat_GetLastError()查看错误码备注：释放资源，全局只调用一次2.2用户接口定义平台SDK开发手册（CS部分）2.2.1登录接口接口名称：intPlat_LoginCMS(constchar*cscmsIP,inticmsPort,constchar*csUserName,constchar*csPSW,intiLoginType=0,intiMqPort=61618);接口描述：用户登录到指定平台参数说明：参数名输入/输出描述cscmsIP[in]中心管理服务器地址，(例“172.7.150.2”)icmsPort[in]中心管理服务器端口。（例80）csUserName[in]用户名（例admin）csPSW[in]用户密码（例admin）iLoginType[in]登录类型。（为预留参数，默认为0）iMqPort[in]MQ服务器端口，默认61618返回值：成功返回一个大于0的会话句柄，错误时返回-1，通过Plat_GetLastError()查看错误码备注：无2.2.2登出接口接口名称：intPlat_LogoutCMS(intiUserHandle);接口描述：用户登出接口参数说明：参数名输入/输出描述iUserHandle[in]Plat_LoginCMS返回的句柄平台SDK开发手册（CS部分）返回值：成功返回0，错误时返回-1，通过Plat_GetLastError()查看错误码备注：无2.3组织资源接口定义2.3.1获取控制中心信息接口接口名称：intPlat_GetAllControlCell(intiUserHandle,intiNeedGetNum,PLAT_CONTROLCELLINFO*pCellBuffer,int*pOutputNum);接口描述：获取控制中心列表信息参数说明：参数名输入/输出描述iUserHandle[in]Plat_LoginCMS返回的句柄iNeedGetNum[in]需要获取的中心个数pCellBuffer[in][out]存放控制单元的缓冲区，由调用者分配pOutputNum[out]输出资源数目，当缓冲区为NULL时，pOutputNum的值为资源的总的数目，其他情况下pOutputNum为成功输出资源的数目返回值：成功返回0，错误时返回-1，通过Plat_GetLastError()查看错误码备注：无2.3.2获取区域信息接口接口名称：intPlat_GetAllRegion(平台SDK开发手册（CS部分）intiUserHandle,intiNeedGetNum,PLAT_REGIONINFO*pRegionBuffer,int*pOutputNum);接口描述：获取区域信息参数说明：参数名输入/输出描述iUserHandle[in]Plat_LoginCMS返回的句柄iNeedGetNum[in]需要获取的资源个数pRegionBuffer[in][out]存放区域的缓冲区，由调用者分配pOutputNum[out]输出资源数目，当缓冲区为NULL时，pOutputNum的值为资源的总的数目，其他情况下pOutputNum为成功输出资源的数目返回值：成功返回0，错误时返回-1，通过Plat_GetLastError()查看错误码备注：无2.4查询权限接口定义2.4.1查询权限接口接口名称：intPlat_CheckRight(intiUserHandle,intiObjectType,intiRightTpye,intiObjectID);接口描述：检查资源权限参数说明：参数名输入/输出描述iUserHandle[in]Plat_LoginCMS返回的句柄iObjectType[in]权限元素类型,见PLAT_PRLOBJTYPE_*平台SDK开发手册（CS部分）iRightTpye[in]权限掩码,见PLAT_PRLMASK_*iObjectID[in]元素ID返回值：有权限时返回0，无权限返回-1备注：无2.5报警/事件订阅接口定义2.5.1订阅报警/事件接口接口名称：intPlat_SubscribeInfo(intiUserHandle,EventSubscribeCallbackfSubscribeCallback,void*pUser);接口描述：订阅报警、事件参数说明：参数名输入/输出描述iUserHandle[in]Plat_LoginCMS返回的句柄fSubscribeCallback[in]报警、事件接收回调函数指针pUser[in]用户数据返回值：0调用成功,-1调用失败，通过Plat_GetLastError()查看错误码备注：无2.5.2取消订阅接口接口名称：intPlat_UnSubscribeInfo(intiUserHandle);平台SDK开发手册（CS部分）接口描述：取消订阅事件参数说明：参数名输入/输出描述iUserHandle[in]Plat_LoginCMS返回的句柄返回值：0调用成功,-1调用失败，通过Plat_GetLastError()查看错误码备注：无2.5.3根据URL获取图片接口名称：intPlat_GetPicDataByURL(intiUserHandle,constchar*pURL,char**pPicData,int*pPicLen);接口描述：根据图片的URL获取图片信息，图片URL可以在订阅报警事件回调中获取参数说明：参数名输入/输出描述iUserHandle[in]Plat_LoginCMS返回的句柄pURL[in]图片URLpPicData[out]图片数据pPicLen[out]图片长度返回值：0调用成功,-1调用失败，通过Plat_GetLastError()查看错误码备注：获取到图片后，需要调用Plat_FreePicData释放内存2.5.4释放图片数据平台SDK开发手册（CS部分）接口名称：intPlat_FreePicData(intiUserHandle,char**pPicData);接口描述：释放图片数据参数说明：参数名输入/输出描述iUserHandle[in]Plat_LoginCMS返回的句柄pPicData[in]图片数据返回值：0调用成功,-1调用失败，通过Plat_GetLastError()查看错误码备注：无2.6订阅状态接口定义2.6.1订阅状态接口接口名称：intPlat_SubscribeState(intiUserHandle,StateCallbackfSubscribeCallback,void*pUser);接口描述：订阅状态接口，包括设备在线状态、门禁状态等参数说明：参数名输入/输出描述iUserHandle[in]Plat_LoginCMS返回的句柄fSubscribeCallback[in]资源状态接收回调函数指针pUser[in]用户数据返回值：平台SDK开发手册（CS部分）0调用成功,-1调用失败，通过Plat_GetLastError()查看错误码备注：无2.6.2取消订阅接口接口名称：intPlat_UnSubscribeState(intiUserHandle);接口描述：取消订阅接口参数说明：参数名输入/输出描述iUserHandle[in]Plat_LoginCMS返回的句柄返回值：0调用成功,-1调用失败，通过Plat_GetLastError()查看错误码备注：无2.7报警接口定义2.7.1获取设备主机信息接口名称：intPlat_VSS_GetDeviceHostInfo(intiUserHandle,intiType,intiNeedGetNum,LPPLAT_VSS_DEVICEHOSTpOutDevHostInfo,int*pOutputNum);接口描述：获取设备主机信息参数说明：参数名输入/输出描述平台SDK开发手册（CS部分）iUserHandle[in]Plat_LoginCMS返回的句柄iType[in]报警设备类型，报警主机：PLAT_DEVICE_ALARM_HOST，消防主机：PLAT_DEVICE_FIRE_HOST，动环主机：PLAT_DEVICE_SENSOR_HOST，停车场管理主机：PLAT_DEVICE_PARK_HOST，巡查主机：PLAT_DEVICE_PATROLiNeedGetNum[in]需要获取的数目pOutDevHostInfo[in][out]报警设备信息输出缓冲区pOutputNum[out]输出资源数目，当pOutDevHostInfo为NULL时，pOutputNum保存的值为资源的总的数目，其他情况下pOutputNum为成功输出资源的数目。返回值：0调用成功,-1调用失败，通过Plat_GetLastError()查看错误码备注：无2.7.2获取设备通道信息接口名称：intPlat_VSS_GetDevChnlInfo(intiUserHandle,intiType,intiNeedGetNum,LPPLAT_VSS_DEVICECHANNELpOutDevChnlInfo,int*pOutputNum);接口描述：获取设备通道信息参数说明：参数名输入/输出描述iUserHandle[in]Plat_LoginCMS返回的句柄iType[in]设备通道类型，报警IO：PLAT_RES_IO，防区：PLAT_RES_DEFENCE_AREA，消防点：PLAT_RES_FIRE_POINT，巡查点：PLAT_RES_PATROL_POINTiNeedGetNum[in]需要获取的数目pOutDevChnlInfo[in][out]报警设备通道信息输出缓冲区pOutputNum[out]输出资源数目，当pOutDevHostInfo为NULL时，平台SDK开发手册（CS部分）pOutputNum保存的值为资源的总的数目，其他情况下pOutputNum为成功输出资源的数目。返回值：0调用成功,-1调用失败，通过Plat_GetLastError()查看错误码备注：无2.7.3报警控制接口名称：intPlat_VSS_AlarmControl(intiUserHandle,intiResourceID,intiCommand);接口描述：获取设备通道信息参数说明：参数名输入/输出描述iUserHandle[in]Plat_LoginCMS返回的句柄iResourceID[in]资源IDiCommand[in]控制命令，报警输出关闭：PLAT_CMD_IOCLOSE，报警输出打开：PLAT_CMD_IOOPEN；报警主机撤防：PLAT_CMD_AL