江苏电信企信通_AI接口说明(C#).docxVIP

江苏电信企信通客户端 API接口说明文档（C#） （V1.0） 联创亚信科技(南京)有限公司 2012年11月 文档修改记录 文档版本 修改人 修改时间 修改内容 V1.0 陈萍 2012-11-9 新建  目 录 1 概述 4 1.1 阅读对象 4 1.2 项目背景 4 2 环境准备 4 2.1 开发环境 4 2.2 使用该包说明 4 2.3 定义类 4 3 API接口定义 5 3.1 接口说明 5 3.2 接口描述 5 4 代码示例 5 5 常见问题 5 6 其他 6  1 概述 1.1 阅读对象 本文档为DLL组件（FullTunnelControl.dll）的使用说明文档，为系统设计人员或程序开发人员应用该开发包进行二次开发而编写，主要服务对象为与该项目有关的项目 管理人员、系统设计人员和系统开发人员。 1.2 项目背景 2 环境准备 2.1 开发环境 操作系统：不限。 2.2 使用该包说明 1) 使用组件需要先注册组件, 例如regsvr32 D:\codes\msg_com_p\FullTunnelControl.dll 2) 运行环境中，字符集编码为GBK。 3) 使用该组件时需要在代码里添加下面几条语句即可 在头文件中加入下列语句(路径根据具体进行修改) #import ..\\FullTunnelControl\\FullTunnelControl.tlb #pragma comment(lib,..\\FullTunnelControl.lib) using namespace FULLTUNNELCONTROLLib; 4) 使用该包提供的用户接口（类）进行开发。 2.3 定义类 3 API接口定义 3.1 接口说明 本组件包括以下几个应用接口，分别如下： 接口名称 类型 功能描述 StartAndManageConnect_User 函数 客户端建立连接接口函数 StartRecv 函数 客户端接收报文信息的接口函数 SendBusinessPkg 函数 客户端发送报文信息的接口函数（仅限普通用户） SendBusinessPkg_New 函数 客户端发送报文信息的接口函数（添加主接入号） SendBusinessPkgByParam 函数 客户端可以用于所有用户类型的客户端发送报文的接口函数 CloseConnect 函数 客户端关闭连接的接口函数 3.2 接口描述 3.2.1 StartAndManageConnect_User接口 功能描述： 调用 StartAndManageConnect_User(name, pwd, ip, port)函数;用于建立连接并发送认证包。(参见SendTest程序中CSendTestDlg::OnConnect()方法) ,如果认证成功后，会创建守护进程（即发送心跳包），维持连接不断开。 接口参数描述： StartAndManageConnect_User(name, pwd, ip, port) 参数 数据类型 描述 约定 name String API用户名 pwd String API用户密码 ip String API公网接连IP地址 01 port Int API访问端口号 9005 用法示例 接口函数返回值 0: S_OK连接认证成功 创建守护线程成功 1: S_FALSE连接认证成功 创建守护线程失败 102 SEND_PAR_USER_ERROE-参数错误:没有输入用户名 103 SEND_PAR_CODE_ERROE-参数错误:没有输入用户密码 104 SEND_PAR_DESTCODE_ERROE-参数错误:没有输入目的号码 // 105 SEND_PAR_IP_ERROE-参数错误:输入的服务器地址不正确 106 SEND_PAR_PORT_ERROE-参数错误:输入的服务器端口不正确 107 SEND_PAR_CONTEXT_ERROE-参数错误:没有输入发送内容 // 108 SEND_PAR_SENDTYPE_ERROE-参数错误:输入发送类型不正确 // 201 SEND_WSAStartup_ERROE-windows启动socket错误 202 SEND_socket_ERROE-WINDOWS的socket()错误 203 SEND_gethostbyname_ERROE-域名解析错误 204 SEND_setsockopt_ERROE-设置选项错误 205 SEND_connect_ERROE-建立连接connect()错误 206 SEND_send_ERROE-发送send()错误,可能是由于连接失效