- 1、本文档共50页,可阅读全部内容。
- 2、原创力文档(book118)网站文档一经付费(服务费),不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。
- 3、本站所有内容均由合作方或网友上传,本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺!文档内容仅供研究参考,付费前请自行鉴别。如您付费,意味着您自己接受本站规则且自行承担风险,本站不退款、不进行额外附加服务;查看《如何避免下载的几个坑》。如果您已付费下载过本站文档,您可以点击 这里二次下载。
- 4、如文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“版权申诉”(推荐),也可以打举报电话:400-050-0827(电话支持时间:9:00-18:30)。
查看更多
平台SDK开发手册 (CS部分)
平台SDK开发手册 (CS客户端部分)
非常感谢选择本公司产品,我们将竭诚为您提供最好的服务。
本手册内容将不定期更新,恕不另行通知;更新内容将在版本更新信息中给出。
如您对手册中的内容有疑惑或者有好的建议,请通过技术支持联系我们。
我们的进步需要您的宝贵意见。
简介
前提
当您阅读该开发手册时,同时应该拿到以下内容:
1. PlatformSDK.h
2. PlatformSDK.dll及其依赖的其他dll
3. PlatSDK_Test,为平台SDK(CS部分)的测试demo,包括C++源代码及可执行程序。
版本信息
版本号日期变更说明1.0.02015-03-23发布
接口定义
初始化/反初始化接口定义
初始化接口
接口名称:
int Plat_Init();
接口描述:
初始化平台SDK
参数说明:
无
返回值:
成功返回0,错误时返回-1,通过 HYPERLINK \l _获取错误码接口 Plat_GetLastError()查看错误码
备注:
初始化接口只需调用一次,在调用任何接口前,必须调用 Plat_Init完成初始化工作
反初始化接口
接口名称:
int Plat_UnInit();
接口描述:
反初始化平台SDK
参数说明:
无
返回值:
成功返回0,错误时返回-1,通过 HYPERLINK \l _获取错误码接口 Plat_GetLastError()查看错误码
备注:
释放资源,全局只调用一次
用户接口定义
登录接口
接口名称:
int Plat_LoginCMS(
const char* cscmsIP,
int icmsPort,
const char* csUserName,
const char* csPSW,
int iLoginType = 0,
int iMqPort = 61618);
接口描述:
用户登录到指定平台
参数说明:
参数名输入/输出描述cscmsIP[in]中心管理服务器地址,(例“”)icmsPort[in]中心管理服务器端口。(例80)csUserName[in]用户名 (例 admin)csPSW[in]用户密码(例admin)iLoginType[in]登录类型。(为预留参数,默认为0)iMqPort[in]MQ服务器端口,默认61618
返回值:成功返回一个大于0的会话句柄,错误时返回-1,通过 HYPERLINK \l _获取错误码接口 Plat_GetLastError()查看错误码
备注:无
登出接口
接口名称:
int Plat_LogoutCMS(int iUserHandle);
接口描述:
用户登出接口
参数说明:
参数名输入/输出描述iUserHandle[in] HYPERLINK \l _登录接口 Plat_LoginCMS返回的句柄
返回值:
成功返回0,错误时返回-1,通过 HYPERLINK \l _获取错误码接口 Plat_GetLastError()查看错误码
备注:
无
组织资源接口定义
获取控制中心信息接口
接口名称:
int Plat_GetAllControlCell(
int iUserHandle,
int iNeedGetNum,
HYPERLINK \l _控制中心结构体_1 PLAT_CONTROLCELLINFO* pCellBuffer,
int* pOutputNum);
接口描述:
获取控制中心列表信息
参数说明:
参数名输入/输出描述iUserHandle[in] HYPERLINK \l _登录接口 Plat_LoginCMS返回的句柄iNeedGetNum[in]需要获取的中心个数pCellBuffer[in][out]存放控制单元的缓冲区,由调用者分配pOutputNum[out]输出资源数目,当缓冲区为NULL时,pOutputNum的值为资源的总的数目,其他情况下pOutputNum为成功输出资源的数目
返回值:
成功返回0,错误时返回-1,通过 HYPERLINK \l _获取错误码接口 Plat_GetLastError()查看错误码
备注:
无
获取区域信息接口
接口名称:
int Plat_GetAllRegion (
int
文档评论(0)