客户端调用DLL接口说明.doc

1、 客户端 DLL 接口说明 int Init()（调用该 DLL 之前应该先调用该函数） 返回值：成功返回 0，失败返回 -1 int KeepoutAlarm (char *pMsgServerIP, short sMsgServerPort, char *pItemName, char *pItemContent) 功能： 视频遮挡报警开关 参数： pItemName： 形如 HIE$192.168.0.10=5050;Admin;888888，等号之前给 pItemName pItemContent： 等号之后给 pItemContent 返回值：成功返回 0，失败返回 -1 int A

2、larmInAlarmOn (char *pMsgServerIP, short sMsgServerPort, char *pItemName, char *pItemContent) 功能： 报警输入布防 参数： pItemName： 形如 HIE9000$192.168.0.11=布防字符串 ，等号之前给 pItemName pItemContent： 等号之后 即布防字符串 给 pItemContent 返回值：成功返回 0，失败返回 -1 int OnOffVilost(char *pMsgServerIP, short sMsgServerPort, char *pItemName

3、, char *pItemContent) 功能：视频丢失报警开关 参数： pItemName： 形如 HIE9000$192.168.0.11=channelnum;0，等号之前给 pItemName pItemContent： 等号之后给 pItemContent 返回值：成功返回 0，失败返回 -1 int OnOffVideoMove(char *pMsgServerIP, short sMsgServerPort, char *pItemName, char *pItemContent) 功能： 视频移动报警开关 参数： pItemName： 形如 HIE9000$192.168.0

4、.11=channelnum;0，等号之前给 pItemName pItemContent： 等号之后给 pItemContent 返回值：成功返回 0，失败返回 -1 int DeviceLog(char *pMsgServerIP, short sMsgServerPort, char *pItemName, char *pItemContent) 功能：设备注册注销 参数： pItemName： 形如 HIE$192.168.0.10=5050;Admin;888888，等号之前给 pItemName pItemContent： 等号之后给 pItemContent 返回值：成功返回 0

5、，失败返回 -1 int AlarmCancel(char *pMsgServerIP, short sMsgServerPort, char *pItemName, char *pItemContent) 功能： 消警 参数： pItemName： 形如 HIE$192.168.0.10=5050;Admin;888888，等号之前给 pItemName pItemContent： 等号之后给 pItemContent 返回值：成功返回 0，失败返回 -1 int AlarmOutput(char *pMsgServerIP, short sMsgServerPort, char *pIte

6、mName, char *pItemContent) 功能： 报警输出 参数： pItemName： 形如 HIE$192.168.0.10=5050;Admin;888888，等号之前给 pItemName pItemContent： 等号之后给 pItemContent 返回值：成功返回 0，失败返回 -1 int GetDeviceOnLine(char *pMsgServerIP, short sMsgServerPort, CTS_MSGSTR_DEVICEONLINE_EX *pDeviceOnLine_in, char *pDevAddr,/从该项开始的参数为传出结构体拆开得来

7、int /设备 ip或者 imei号 ,dtu 就是 userid int iDevType; /设备主类型，比如 MP902 int iDevSubType; /是不是还该有个子类型，比如 dtu的， =1表示是个 dtu，否则不是int bOnline; /是否在线 ,1 为在线 (此时 m_lastpingtime 值无效 )，其他值表示不可知该设备是否在线，需要参考 m_lastpingtime time_t lastpingtime; /上次 ping(收到活动数据包 )的时间 ,0 表示 bOnline 项有效而本项无效 (只能判断是否在线 ) time_t currtime; /

8、当前的时间 bool bFindDev; /是否有该设备的痕迹， client 端应该先判断此，从而知道消息服务器中是否有该设备的信息 CTS_MSGSTR_DEVICEONLINE_EX,*LPCTS_MSGSTR_DEVICEONLINE_EX; 返回值：成功返回 0，失败返回 -1 int SetMsgServer(char *pMsgServerIP, short sMsgServerPort, char *pClientIP, short sClientPort, char *pUserID, int Flag) 功能：设置 消息 服务器 ，第一次和某一 消息 服务器通讯必须首先调用

9、该函数 参数： pMsgServerIP：你要通讯的消息服务器 IP sMsgServerPort：你要通讯的消息服务器端口 pClientIP：你自己的（客户端） IP sClientPort：你自己的端口号 pUserID：用户 ID Flag： 标志，传字符“ 0”消息服务器会删除保存着的你的 IP 及端口信息，首次调用传字符“ 1”，消息服务器会把你的 IP及端口信息保存起来 返回值：成功返回 0，失败 返回 -1 int ConnectSignalServer(char *pSignalServerIP, short sSignalServerPort, char *pClientI

10、P, short sClientPort, char *pUserID, char *Flag) 功能：长连接订阅信令服务 参数： pSignalServerIP：信令服务 IP sSignalServerPort：信令服务端口 pClientIP：客户端 IP sClientPort：客户端端口 pUserID：用户登入帐号 Flag：标志，字符“ 0”代表取消订阅，字符“ 1”代表订阅 int SetSignalServer(char *pSignalServerIP, short sSignalServerPort, char *pClientIP, short sClientPort,

11、 char *pUserID, int Flag) 功能：设置信令服务器，第一次和某一信令服务器通讯必须首先调用该函数 参数： pMsgServerIP：你要通讯的消息服务器 IP sMsgServerPort：你要通讯的消息服务器端口 pClientIP：你自己的（客户端） IP sClientPort：你自己的端口号 pUserID: 登入 ID，对于每个客户端来说是唯一值 Flag：标志，传字符“ 0”信令服务器会删除保存着的你的 IP 及端口信息，首次调用传字符“ 1”，信令服务器会把你的 IP及端口信息保存起来 返回值：成功返回 0，失败返回 -1 int Exit() 功能：当不再

12、使用该 DLL时，可以调用此函数释放 DLL占用的资源 。 返回值：成功返回 0，失败返回 -1 int PasswordChange(char* pUserPhone, char *pSIM, char *pDeviceType, char *pOld, char *pNew, char *pErrorCode); 功能：修改密码 (mp902) 参数 ： pUserPhone：传一个随机手机号的字符串就行 pSIM：指向 SIM卡号字符串的指针（下同） pDeviceType:指向设备类型标示符的指针（下同） pOld：旧密码 （ 密码只能是 4 位字符） pNew： 新密码 pError

13、Code：返回：函数具体执行状况 ，返回 50字节的内容 ，所以给的内存必须大于等于 50 字节，下同 返回值 ：成功 返回 0，失败返回 -1 int AlarmMode(char* pUserPhone, char *pSIM, char *pPassword, char *pDeviceType, short sAlarmMode, char *pErrorCode); 功能： 紧急键报警方式 (mp902) 参数 ： pUserPhone：传一个随机手机号的字符串就行 sAlarmMode： 取 值为 0，拨打电话； 取值 为 1，发送短信及照片 ，取其余值，非法。 返回值 ： 成功返

14、回 0，失败返回 -1 int AlarmOn（ char *pUserPhone, char *pSIM, char *pPassword, char *pDeviceType, char *pErrorCode） 功能： 布防 (mp902) 参数： pUserPhone： 传一个随机手机号的字符串就行 pPassword：密码 pDeviceType：设备类型 pErrorCode：错误码 返回值 ：成功返回 0，失败返回 -1 int AlarmOff（ char* pUserPhone, char *pSIM, char *pPassword, char *pDeviceType,

15、char *pErrorCode） 功能：撤防 (mp902) 参数： pUserPhone： 传一个随机手机号的字符串就行 pPassword：密码 pDeviceType：设备类型 pErrorCode：错误码 返回值 ：成功返回 0，失败返回 -1 int SensorAdd(char *pUserPhone, char *pSIM, char *pPassword, char *pDeviceType, char *pSensorType, char *pSensorName, char *pErrorCode) 功能：增加传感器 (mp902， mp903 通用 ) 参数： pUse

16、rPhone： 传一个随机手机号的字符串就行 pSIM： SIM 卡号 pPassword：密码 pDeviceType：设备类型 pSensorType：传感器类型， 0 代表有线， 1代表无线 pSensorName：传感器名称，只能是英文或数字，最多 50位 pErrorCode：错误码 返回值 ：成功返回 0，失败返回 -1 int SensorDel(char* pUserPhone, char *pSIM, char *pPassword, char *pDeviceType, char *pSensorType, char *pSensorName, char *pErrorCo

17、de) 功能：删除传感器 (mp902 调用删除全部传感器， mp903 调用删除某个传感器 ) 参数： pUserPhone： 传一个随机手机号的字符串就行 pSIM： SIM 卡号 pPassword：密码 pDeviceType：设备类型 pSensorType：传感器类型， 0 代表有线， 1代表无线 pSensorName：传感器名，用于 902传空字符串，用于 903传某个传感器名 pErrorCode：错误码 返回值 ：成功返回 0，失败返回 -1 int RemotecontrollerDel(char* pUserPhone, char *pSIM, char *pPassw

18、ord char *pDeviceType, char *pErrorCode) 功能：删除遥控器 (mp902) 参数： pUserPhone： 传一个随机手机号的字符串就行 pPassword：密码 pDeviceType：设备类型 pErrorCode：错误码 返回值 ：成功返回 0，失败返 回 -1 int InfraredDeviceOn(char* pUserPhone, char *pSIM, char *pPassword, char *pDeviceType, char *pErrorCode) 功能： 开启内置红外人体探测器 (mp902) 参数： pUserPhone：

19、传一个随机手机号的字符串就行 pPassword：密码 pDeviceType：设备类型 pErrorCode：错误码 返回值 ：成功返回 0，失败返回 -1 int InfraredDeviceOff(char* pUserPhone, char *pSIM, char *pPassword, char *pDeviceType, char *pErrorCode) 功能： 关闭内置红外人体探测器 (mp902) 参数： pUserPhone： 传一个随机手机号的字符串就行 pPassword：密码 pDeviceType：设备类型 pErrorCode：错误码 返回值 ：成功返回 0，失败

20、返回 -1 int InfraredLightOff(char* pUserPhone, char *pSIM, char *pPassword, char *pDeviceType, char *pErrorCode) 功能： 红外灯关 (mp902) 参数： pUserPhone： 传一个随机手机号的字符串就行 pPassword：密码 pDeviceType：设备类型 pErrorCode：错误码 返回值 ：成功返回 0，失败返回 -1 int InfraredLightOn(char* pUserPhone, char *pSIM, char *pPassword, char *pDe

21、viceType, char *pErrorCode) 功能： 红外灯开 (mp902) 参数： pUserPhone： 传一个随机手机号的字符串就行 pPassword：密码 pDeviceType：设备类型 pErrorCode：错误码 返回值 ：成功返回 0，失败返回 -1, int GetPhotos(char* pUserPhone, char *pSIM, char *pPassword, char *pDeviceType, short sNum, char *pErrorCode) 功能： 索取照片 (mp902) 参数： pUserPhone： 传一个随机 手机号的字符串就行

22、 pPassword：密码 pDeviceType：设备类型 sNum：照片张数 ， 照片图像的大小设置为 160x128或者 320x240 时，一次可以请求最多 8张照片；当照片图像的大小设置为 640x480 时，则最多一次可以请求 2张照片 pErrorCode：错误码 返回值 ：成功返回 0，失败返回 -1 int SendPhotosToMobile(char* pUserPhone, char *pSIM, char *pPassword, char *pDeviceType, short sNum, char *pPhoneNum, char *pErrorCode) 功能：

23、索取照片到指定手机 (mp902) 参数： pUserPhone： 传一个随机手机号的字符串就行 pPassword：密码 pDeviceType：设备类型 sNum：照片张数 ； pPhoneNum： 指定的 手机号 pErrorCode：错误码 返回值 ：成功返回 0，失败返回 -1 int ResetDevice(char* pUserPhone, char *pSIM, char *pPassword, char *pDeviceType, char *pErrorCode) 功能： 恢复运营商设置 (mp902,mp903) 参数： pUserPhone： 传一个随机手机号的字符串就

24、行 pPassword：密码 pDeviceType：设备类型 pErrorCode：错误码 返回值 ：成功返回 0，失败返回 -1 int SetMMSCenter(char* pUserPhone, char *pSIM, char *pPassword, char *pDeviceType, char *pNetWeb, char *pErrorCode) 功能： 设置彩信中心 (mp902,mp903) 参数： pUserPhone： 传一个随机手机号的字符串就行 pPassword：密码 pDeviceType：设备类型 pNetWeb：彩信中心网站 （字符串形式） pErrorCo

25、de：错误码 返回值 ：成功返回 0，失败返回 -1 int SetMMSAPN(char* pUserPhone, char *pSIM, char *pPassword, char *pDeviceType, char *pGateWay, short sPort, char *pAPN, char *pUser, char *pAPNPassword, char *pErrorCode) 功能： 设置彩信 APN 参数 (mp902,mp903) 参数 ： pUserPhone：传一个随机手机号的字符串就行 pGateway：网关 sPort：端口 pAPN： APN pUser： AP

26、N 用户名 pPassword： APN密码 返回值 ：成功返回 0，失败返回 -1 int AlarmSendSMSOff(char* pUserPhone, char *pSIM, char *pPassword, char *pDeviceType, char *pErrorCode) 功能： 报警时不发短信 (mp902) 参数： pUserPhone： 传一个随机手机号的字符串就行 pPassword：密码 pDeviceType：设备类型 pErrorCode：错误码 返回值 ：成功返回 0，失败返回 -1 int AlarmSendSMSOn(char* pUserPhone,

27、char *pSIM, char *pPassword, char *pDeviceType, char *pErrorCode) 功能： 报警时发短信 (mp902) 参数： pUserPhone： 传一个随机手机号的字符串就行 pPassword：密码 pDeviceType：设备类型 pErrorCode：错误码 返回值 ：成功返回 0，失败返回 -1 int AlarmCallPhoneOff(char* pUserPhone, char *pSIM, char *pPassword, char *pDeviceType, char *pErrorCode) 功能： 报 警时不拨打主人电话 (mp902) 参数： pUserPhone： 传一个随机手机号的字符串就行 pPassword：密码 pDeviceType：设备类型 pErrorCode：错误码 返回值 ：成功返回 0，失败返回 -1 int AlarmCallPhoneOn(char* pUserPhone, char *pSIM, char *pPassword, char *pDeviceType, char *pErrorCode)