[日志管理详细设计LogManage.docVIP

卷号 卷内编号 密级 应用软件详细设计说明书 项目名称： 部门级文档管理系统 项目编号： 模块名称： LogManage(日志管理) 模块编号： 编写人员： **** 编写日期： 2004-6-8 审批人员： 审批日期： 历史修改记录 版本号 修改人/日期 摘要 审定人/日期 目录 1 引言 2 1.1 编写目的 2 1.1.1 目的 2 1.1.2 文档预期读者 3 1.2 项目背景 3 1.3 定义 3 1.4 参考资料 3 2 设计说明 3 2.1 程序简述 3 2.1.1 引用命名空间 3 2.1.2 命名空间 3 2.1.3 类名 3 2.2 程序功能描述 3 2.2.1 函数列表 3 2.2.2 函数功能说明 4 2.3 注释设计 9 2.4 限制条件 9 2.5 测试计划 9 2.6 尚未解决得问题 9 引言 编写目的 目的 描述部门级文档管理系统LogManage类模块的详细设计。 文档预期读者 项目经理、系统分析员、研发经理、测试经理、项目组长、系统开发人员。 项目背景武汉开目信息技术有限责任公司定义设计说明using System; using System.Data; using PartDM.DBOperate; 命名空间 PartDM. LogManage 类名 LogManage 程序功能描述 将指定的日志写入数据库 外 public int SGetLog(int logTime,int OState,out DataSet logDataSet) {} 服务器日志查询 外 private int ExecuteSelect(int time,int state,out DataSet logDataSet){} 用语执行内嵌的SWITCH查询字符串 内 函数功能说明 查询记录并得到记录集 函数名： AddLog 函数定义：public int Addlog(string SQLstring) 访问权限：public 参数： 参数名 类型 说明 SQLstring string 执行操作的SQL语句 返回值类型：int 值 说明 0 插入成功 服务器日志查询 函数名： SGetLog 函数定义：public int SGetLog(int logTime,int OState,out DataSet logDataSet) 访问权限：public 参数： 参数名 类型 说明 logTime int 查询时间(0为所有时间,3为3天以内,7为7天以内) OState int 操作状态(0为成功,1为失败,2为所有操作) logDataSet out DataSet 查询的输出型的记录集 返回值类型：int 值 说明 0 插入成功 2197 服务器操作条件不符，操作失败 用于执行内嵌的SWITCH查询字符串 函数名： ExecuteSelect 函数定义：private int ExecuteSelect(int time,int state,out DataSet logDataSet) 访问权限：public 参数： 参数名 类型 说明 time int 查询时间(0为所有时间,3为3天以内,7为7天以内) state int 操作状态(0为成功,1为失败,2为所有操作) logDataSet out DataSet 查询的输出型的记录集 返回值类型：int 值 说明 0 插入成功 2197 服务器操作条件不符，操作失败 注释设计 在方法的前面标注注释，描述该方法的功能，参数类型，返回值。 声明变量应标注该变量的用途。 在判断错误的位置加注释，说明是什么错误。 限制条件 在调用本模块前，有必要先进行注册，将数据库连接串输入到注册表。 要引用DBOperate模块。 测试计划 请参照单元测试计划说明书。 尚未解决得问题 无 湖北国际软件外包人才培养基地 LogManage详细设计说明书 2 湖北国际软件外包人才培养基地