宽乐通信COM SDK（短信部分）接口说明书.doc

宽乐通信COM SDK（短信部分）接口说明书 广东省电信有限公司研究院 2007年4月修订记录 日期 修订版本 作者 描述 2007年4月17日 V1.0 刘豪 初版 目 录 修订记录 I 1. 总述 1 1.1. COM SDK说明 1 1.2. 实现的功能 1 2. 用户接口 1 2.1. 基础工具模块 2 2.1.1. IFstAttrList Interface 2 2.1.2. IFstRowSet Interface 7 2.1.3. IFstDataSet Interface 13 2.1.4. IFstCmd Interface 15 2.2. 登陆注册模块 19 2.2.1. IFstLogin Interface 19 2.2.2. IFstLoginEvents Interface 20 2.3. Stack模块 21 2.3.1. IFstSipStack Interface 22 2.3.2. IFstSipStackEvents Interface 24 2.4. 短信模块 25 2.4.1. IFstSMS Interface 25 2.4.2. IFstSMSEvents Interface 30 2.4.3. IFstMsgInfo Interface 32 2.4.4. IFstGetOfflineMsg Interface 36 2.4.5. IFstGetOfflineMsgEvents Interface 37 2.4.6. IFstSetOfflineMsg Interface 38 2.4.7. IFstSetOfflineMsgEvents Interface 39 2.4.8. IFstSplitMsg Interface 40 2.4.9. IFstSplitResult Interface 43 3. 通用失败码 46 4. 开发指导 46 4.1. 准备 46 4.2. 建立一个简单的VC示例程序 47 4.3. 导入类型库 48 4.3.1. 复制组件 DLL到工程目录 48 4.3.2. 导入类型库 49 4.4. 编写事件接收器 50 4.5. 调用组件，响应事件 52 4.6. 运行程序 53 附：关键步骤说明 53 摘要：本文档主要描述宽乐通信COM SDK开发包为第三方开发商提供的接口说明（短信部分）。对第三方调用本业务接口的方法，以及接口本身的参数定义作了详细说明。 申明：宽乐通信SDK开发包提供给第三方用以开发特定的软件/通信产品，第三方需严格按照要求使用，不得私自外传及用于其他目的。 总述 COM SDK说明 宽乐通信各业务组件接口都以COM接口方式提供，第三方可以利用COM SDK提供的组件及接口调用系统的各业务能力，在短时间内快速开发相关的业务功能，从而更能专注于用户需求，改善用户体验。 COM SDK可以支持多种开发环境和开发语言的调用。如：可以在VS.NET 2003，VS.NET 2005，VC6.0，VB6.0，Delphi，VS.NET C#，Java开发环境和开发语言中进行调用。 实现的功能 第三方开发商可以通过调用SDK开发包提供的接口使用宽乐通信业务的短信能力。 目前，实现的功能有： －短信 －发送短信 －接收回执 －接收短信 －获取离线短信 用户接口 短信功能涉及到的功能模块有：基础工具模块、登陆注册模块、Stack模块、短信模块。 基础工具模块 IFstAttrList Interface 此接口管理多个属性对的集合，并允许对属性对集合内部数据进行访问。属性集是宽乐通信SDK各个接口中比较常用的数据类型，以键、值映射的方式构成属性对，同时增加了对于键名的索引功能。 IFstAttrList Interface包含以下Property/Method： Count 获取属性集的属性对个数 Name 根据索引获取属性集中对应位置的属性键名 Value 根据属性名或下标设置或获取属性值 Exists 根据条件判断某属性对是否存在 Delete 根据条件删除某属性对 Clear 清空属性集 Clone 为属性集建立副本 ParseString 将字符串解析为属性集 ParseXml 将XML解析为属性集 ToString 将属性集转化为字符串 ToXml 将属性集转化为Xml IFstAttrList::Count Property 获取属性集中属性对的个数 Syntax： HRESULT IFstAttrList::get_Count LONG* pVal Parameters： pVal 返回属性集中属性对的个数。 Return Value： 成功则返回S_OK。 IFstAttrList::Na