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

江苏电信企信通客户端API接口说明文档（C#）（V1.0）联创亚信科技(南京)有限公司2012年11月文档修改记录文档版本修改人修改时间修改内容V1.0陈萍2012-11-9新建目 录1概述41.1阅读对象41.2项目背景42环境准备42.1开发环境42.2使用该包说明42.3定义类43API接口定义53.1接口说明53.2接口描述54代码示例55常见问题56其他6概述阅读对象本文档为DLL组件（FullTunnelControl.dll）的使用说明文档，为系统设计人员或程序开发人员应用该开发包进行二次开发而编写，主要服务对象为与该项目有关的项目管理人员、系统设计人员和系统开发人员。项目背景环境准备开发环境操作系统：不限。使用该包说明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) 使用该包提供的用户接口（类）进行开发。定义类API接口定义接口说明本组件包括以下几个应用接口，分别如下：接口名称类型功能描述StartAndManageConnect_User函数客户端建立连接接口函数StartRecv函数客户端接收报文信息的接口函数SendBusinessPkg函数客户端发送报文信息的接口函数（仅限普通用户）SendBusinessPkg_New函数客户端发送报文信息的接口函数（添加主接入号）SendBusinessPkgByParam函数客户端可以用于所有用户类型的客户端发送报文的接口函数CloseConnect函数客户端关闭连接的接口函数接口描述StartAndManageConnect_User接口功能描述：调用 StartAndManageConnect_User(name, pwd, ip, port)函数;用于建立连接并发送认证包。(参见SendTest程序中CSendTestDlg::OnConnect()方法) ,如果认证成功后，会创建守护进程（即发送心跳包），维持连接不断开。接口参数描述：StartAndManageConnect_User(name, pwd, ip, port)参数数据类型描述约定nameStringAPI用户名pwdStringAPI用户密码ipStringAPI公网接连IP地址01portIntAPI访问端口号9005用法示例接口函数返回值0:S_OK连接认证成功 创建守护线程成功1:S_FALSE连接认证成功 创建守护线程失败102SEND_PAR_USER_ERROE-参数错误:没有输入用户名103SEND_PAR_CODE_ERROE-参数错误:没有输入用户密码104SEND_PAR_DESTCODE_ERROE-参数错误:没有输入目的号码 //105SEND_PAR_IP_ERROE-参数错误:输入的服务器地址不正确106SEND_PAR_PORT_ERROE-参数错误:输入的服务器端口不正确107SEND_PAR_CONTEXT_ERROE-参数错误:没有输入发送内容 //108SEND_PAR_SENDTYPE_ERROE-参数错误:输入发送类型不正确 //201SEND_WSAStartup_ERROE-windows启动socket错误202SEND_socket_ERROE-WINDOWS的socket()错误203SEND_gethostbyname_ERROE-域名解析错误204SEND_setsockopt_ERROE-设置选项错误205SEND_connect_ERROE-建立连接connect()错误206SEND_send_ERROE-发送send()错误,可能是由于连接失效207SEND_SOCKET_ERROR-发送send()返回SOCKET错误208SEND_recv_ERROR-接受recv()错误209SEND_TYPE_AUTH_REPLY_ERROR-认证请求的响应类型错误,响应类型不符合协议301服务器返回结果:-服务器系统错误 302服务器返回结果:-登录用户名错误303服务器返回结果:-登录密码错误304服务器返回结果:-连接数超过限制305服务器返回结果:-每秒发送条目数超过限制306服务器返回结果:-发送的目的号码受限制307服务器返回结果:-