idoc文档管理系统API开发手册
版权所有 北京联高软件开发有限公司
http://www.315soft.com
目录
idoc文档管理系统API开发手册 .................................................................................................. 1
第一章 概述 ....................................................................................................................... 3
1.1 目录及文件说明 ................................................................................................... 3 1.2 控件注册 ............................................................................................................... 3 1.3 接口调用的环境 ........................................................................................................ 3 第二章 API函数接口 ....................................................................................................... 4
2.1 设置服务器信息 ........................................................................................................ 4 2.2 登录服务器 ................................................................................................................ 4 2.3 新建目录 .................................................................................................................... 5 2.4 删除目录 .................................................................................................................... 5 2.5 目录重命名 ................................................................................................................ 6 2.6 上传文件 .................................................................................................................... 6 2.7 文件下载 .................................................................................................................... 7 2.8 文件删除 .................................................................................................................... 7 2.9 文件重命名 ................................................................................................................ 8 2.10 提取文件正文 .......................................................................................................... 9 2.11 修改摘要 .................................................................................................................. 9 2.12 得到文件信息 ........................................................................................................ 10 2.13 得到系统的组织结构 ............................................................................................ 11 2.14 得到组目录结构 .................................................................................................... 12 2.15 得到目录文件 ........................................................................................................ 13 2.16 目录授权 ................................................................................................................ 14 2.17 文件授权 ................................................................................................................ 15 2.18 搜索 ........................................................................................................................ 16 2.19 注册用户 ................................................................................................................ 17 2.20 修改密码 ................................................................................................................ 18 2.21 得到登录的URL ................................................................................................... 18 2.12 得到用户密码的MD5 .......................................................................................... 19
第一章 概述
该文档详细讲述多可文档管理系统API接口定义以及API中的常量定义。
开发版本为V1.0。
适用于多可文档管理系统V2.5以上版本。
1.1 目录及文件说明
idocAPI.ocx 接口ActiveX文件
/ApiTest(c#) NET调用接口实例（） /ApiTest(delphi) delphi调用接口实例
1.2 控件注册
idocAPI.ocx 需要注册，注册过程如下：
win“开始”-> 点击“运行”-> 输入命令“cmd”，出现窗口，运行命令regsvr32 c:\\idoc\\binn\\idocAPI.ocx 即可（c:\\idoc\\binn\\为文件所在目录）。
1.3 接口调用的环境
首先需要启动idoc多可系统，您可用通过idocAPI.ocx连接idoc多可服务器，通过TCP/HTTP实现接口调用。
第二章 API函数接口
2.1 设置服务器信息
int SetServerInfo(
string ServerHost, int ServerPort );
功能说明： 设置服务器IP地址和端口。
参数： ServerHost：[in]服务器IP地址； ServerPort：[in]服务器端口；
返回值： 1： 设置成功； 10：IP地址或者端口格式错误。 11：连接服务器失败，请检查网络连接情况以及服务器地址和端口是否设置正确； 2.2 登录服务器
int Login(
string UserName, string Password );
功能说明： 登录多可文档管理系统。
参数： UserName：[in]用户名； Password：[in]密码；
返回值： 1： 登录成功； 11：连接服务器失败，请检查网络连接情况以及服务器地址和端口是否设置正确； 12：网络传输错误； 13：登录失败，可能原因：用户名和密码错误、用户被禁用、用户未通过审核等； 17：没有设置服务器地址，不能登录。
2.3 新建目录
int FolderNew(
int OwnerId, long FatherId,
string NewFolderName );
功能说明： 在某个工作组或者目录下新建目录。
参数： OwnerId：[in]新建的目录所在的工作组ID，如果是个人文档下则是用户ID； FatherId：[in]新建目录的父目录ID，如果是直接在工作组或者个人下新建目录，则该参数为0； NewFolderName：[in]新建目录的名字，不能包含下列符号：” / \\ : * ? < > |，长度小于64。
返回值： 1： 新建成功； 14：没有登录或者登录信息错误，不能进行操作； 20：参数无效； 21：父目录不存在； 22：目录名包含非法字符或者太长； 23：没有相应权限；
25：服务器端存在该目录名。 2.4 删除目录
int FolderDel(
int OwnerId, long FolderId );
功能说明： 删除某个目录及其子目录和文件。
参数： OwnerId：[in]所要删除的目录所在的工作组ID，如果是个人文档，则为个人ID； FolderId：[in]所要删除的目录的ID。
返回值： 1： 删除成功；
idoc文档管理系统API开发手册
