OLA 文档中心

主题

2026-08-20

清理旧日志文件 - LogCleanupOldFiles ​

函数简介 ​

清理超过保留数量的旧日志文件。

接口名称 ​

LogCleanupOldFiles

DLL调用 ​

c
int32_t LogCleanupOldFiles(int64_t instance, int64_t loggerHandle, int32_t keepCount);

参数说明 ​

参数名类型说明
instance长整数型OLAPlug对象的指针，由 CreateCOLAPlugInterFace 接口生成。
loggerHandle长整数型日志实例句柄（0 表示默认实例）。
keepCount整数型保留文件数量（-1 表示使用配置值）。

示例 ​

keepCount=-1 使用 LogSetMaxFiles 配置；也可传入具体数量（如 5）。

SDK 调用 ​

cpp
#include "OLAPlugServer.h"
#include <cstdio>

OLAPlugServer ola;
const int64_t logger = 0; // 默认实例

ola.LogSetBaseDirectory(logger, "D:\\logs");
ola.LogSetFileNamePattern(logger, "app_{date}_{index}.log");
ola.LogSetMaxFiles(logger, 20);
// 按 MaxFiles 清理；或 LogCleanupOldFiles(logger, 5) 只保留 5 个
int ret = ola.LogCleanupOldFiles(logger, -1); // use MaxFiles
if (ret != 1) {
    return;
}
int count = ola.LogGetTotalFilesCount(logger);
std::printf("total files: %d\n", count);
csharp
using System;
using OLAPlug;

var ola = new OLAPlugServer();
long logger = 0;

ola.LogSetBaseDirectory(logger, @"D:\logs");
ola.LogSetFileNamePattern(logger, "app_{date}_{index}.log");
ola.LogSetMaxFiles(logger, 20);
// 按 MaxFiles 清理；或 LogCleanupOldFiles(logger, 5) 只保留 5 个
int ret = ola.LogCleanupOldFiles(logger, -1); // use MaxFiles
if (ret != 1) return;
int count = ola.LogGetTotalFilesCount(logger);
Console.WriteLine("total files: " + count);
python
from OLAPlugServer import OLAPlugServer

ola = OLAPlugServer()
logger = 0

ola.LogSetBaseDirectory(logger, r"D:\logs")
ola.LogSetFileNamePattern(logger, "app_{date}_{index}.log")
ola.LogSetMaxFiles(logger, 20)
# 按 MaxFiles 清理；或 LogCleanupOldFiles(logger, 5) 只保留 5 个
ret = ola.LogCleanupOldFiles(logger, -1)  # use MaxFiles
if ret != 1:
    raise RuntimeError("failed")
count = ola.LogGetTotalFilesCount(logger)
print("total files:", count)
java
import com.olaplug.OLAPlugServer;

OLAPlugServer ola = new OLAPlugServer();
long logger = 0;

ola.LogSetBaseDirectory(logger, "D:\\logs");
ola.LogSetFileNamePattern(logger, "app_{date}_{index}.log");
ola.LogSetMaxFiles(logger, 20);
// 按 MaxFiles 清理；或 LogCleanupOldFiles(logger, 5) 只保留 5 个
int ret = ola.LogCleanupOldFiles(logger, -1); // use MaxFiles
if (ret != 1) {
    return;
}
int count = ola.LogGetTotalFilesCount(logger);
System.out.println("total files: " + count);
go
import (
    "fmt"
    "github.com/ola/olaplug/olaplug"
)

ola, _ := olaplug.NewOLAPlugServer("OLAPlug_x64.dll")
defer ola.ReleaseObj()
logger := int64(0)

ola.LogSetBaseDirectory(logger, `D:\logs`)
ola.LogSetFileNamePattern(logger, "app_{date}_{index}.log")
ola.LogSetMaxFiles(logger, 20)
// 按 MaxFiles 清理；或 LogCleanupOldFiles(logger, 5) 只保留 5 个
ret := ola.LogCleanupOldFiles(logger, -1) // use MaxFiles
if ret != 1 {
    return
}
count := ola.LogGetTotalFilesCount(logger)
fmt.Println("total files:", count)
rust
use olaplug::OLAPlugServer;

let ola = OLAPlugServer::new("OLAPlug_x64.dll").unwrap();
let logger = 0i64;

ola.log_set_base_directory(logger, r"D:\logs");
ola.log_set_file_name_pattern(logger, "app_{date}_{index}.log");
ola.log_set_max_files(logger, 20);
// 按 MaxFiles 清理；或 LogCleanupOldFiles(logger, 5) 只保留 5 个
let ret = ola.log_cleanup_old_files(logger, -1); // use MaxFiles
if ret != 1 {
    return;
}
let count = ola.log_get_total_files_count(logger);
println!("total files: {}", count);
cpp
var ola = com("OlaPlug.OlaSoft")
var logger = 0

ola.LogSetBaseDirectory(logger, "D:\\logs")
ola.LogSetFileNamePattern(logger, "app_{date}_{index}.log")
ola.LogSetMaxFiles(logger, 20)
// 按 MaxFiles 清理；或 LogCleanupOldFiles(logger, 5) 只保留 5 个
var ret = ola.LogCleanupOldFiles(logger, -1) // use MaxFiles
if(ret == 1) {
    var count = ola.LogGetTotalFilesCount(logger)
    traceprint("total files: " + count)
}
vbscript
Set ola = CreateObject("OlaPlug.OlaSoft")
logger = 0

ola.LogSetBaseDirectory logger, "D:\logs"
ola.LogSetFileNamePattern logger, "app_{date}_{index}.log"
ola.LogSetMaxFiles logger, 20
' 按 MaxFiles 清理；或 LogCleanupOldFiles(logger, 5) 只保留 5 个
ret = ola.LogCleanupOldFiles(logger, -1)
If ret = 1 Then
    count = ola.LogGetTotalFilesCount(logger)
    TracePrint "total files: " & count
End If
text
.局部变量 ola, OLAPlug
.局部变量 ret, 整数型
.局部变量 logger, 长整数型
.局部变量 count, 整数型

ola.Create ()
logger ＝ 0

ola.LogSetBaseDirectory (logger, “D:\logs”)
ola.LogSetFileNamePattern (logger, “app_{date}_{index}.log”)
ola.LogSetMaxFiles (logger, 20)
' 按 MaxFiles 清理；或 LogCleanupOldFiles(logger, 5) 只保留 5 个
ret ＝ ola.LogCleanupOldFiles (logger, -1)  ' use MaxFiles
.如果真 (ret ＝ 1)
    count ＝ ola.LogGetTotalFilesCount (logger)
    调试输出 (“total files：”, count)
.如果真结束
aardio
import OLAPlugServer;
var ola = OLAPlugServer();
var logger = 0;

ola.LogSetBaseDirectory(logger, "D:\\logs");
ola.LogSetFileNamePattern(logger, "app_{date}_{index}.log");
ola.LogSetMaxFiles(logger, 20);
// 按 MaxFiles 清理；或 LogCleanupOldFiles(logger, 5) 只保留 5 个
var ret = ola.LogCleanupOldFiles(logger, -1); // use MaxFiles
if(ret == 1){
    var count = ola.LogGetTotalFilesCount(logger);
    io.print("total files: ", count);
}
text
变量 ola <类型 = OLAPlugServer>
ola = 新建 OLAPlugServer
长整数 logger = 0

ola.LogSetBaseDirectory(logger, "D:\\logs")
ola.LogSetFileNamePattern(logger, "app_{date}_{index}.log")
ola.LogSetMaxFiles(logger, 20)
' 按 MaxFiles 清理；或 LogCleanupOldFiles(logger, 5) 只保留 5 个
整数 ret = ola.LogCleanupOldFiles(logger, -1)  ' use MaxFiles
如果真 (ret ＝ 1)
{
    整数 count = ola.LogGetTotalFilesCount(logger)
    调试输出 ("total files：", count)
}
cpp
#include "OLAPlugServer.h"
#include <cstdio>

OLAPlugServer ola;
int64_t logger = 0;

ola.LogSetBaseDirectory(logger, "D:\\logs");
ola.LogSetFileNamePattern(logger, "app_{date}_{index}.log");
ola.LogSetMaxFiles(logger, 20);
// 按 MaxFiles 清理；或 LogCleanupOldFiles(logger, 5) 只保留 5 个
int32_t ret = ola.LogCleanupOldFiles(logger, -1); // use MaxFiles
if (ret != 1) {
    return;
}
int32_t count = ola.LogGetTotalFilesCount(logger);
std::printf("total files: %d\n", count);

原生 DLL 调用 ​

cpp
long instance = CreateCOLAPlugInterFace();
long logger = 0;

LogSetBaseDirectory(instance, logger, "D:\\logs");
LogSetFileNamePattern(instance, logger, "app_{date}_{index}.log");
LogSetMaxFiles(instance, logger, 20);
int ret = LogCleanupOldFiles(instance, logger, -1);
// 或 LogCleanupOldFiles(instance, logger, 5);
int count = LogGetTotalFilesCount(instance, logger);
csharp
using System.Runtime.InteropServices;

[DllImport("OLAPlug_x64.dll", CallingConvention = CallingConvention.StdCall)]
static extern long CreateCOLAPlugInterFace();
[DllImport("OLAPlug_x64.dll", CallingConvention = CallingConvention.StdCall)]
static extern int LogSetBaseDirectory(long ola, long loggerHandle, string baseDirectory);
[DllImport("OLAPlug_x64.dll", CallingConvention = CallingConvention.StdCall)]
static extern int LogSetFileNamePattern(long ola, long loggerHandle, string fileNamePattern);
[DllImport("OLAPlug_x64.dll", CallingConvention = CallingConvention.StdCall)]
static extern int LogSetMaxFiles(long ola, long loggerHandle, int maxFiles);
[DllImport("OLAPlug_x64.dll", CallingConvention = CallingConvention.StdCall)]
static extern int LogCleanupOldFiles(long ola, long loggerHandle, int keepCount);
[DllImport("OLAPlug_x64.dll", CallingConvention = CallingConvention.StdCall)]
static extern int LogGetTotalFilesCount(long ola, long loggerHandle);

long instance = CreateCOLAPlugInterFace();
long logger = 0;

LogSetBaseDirectory(instance, logger, @"D:\logs");
LogSetFileNamePattern(instance, logger, "app_{date}_{index}.log");
LogSetMaxFiles(instance, logger, 20);
int ret = LogCleanupOldFiles(instance, logger, -1);
int count = LogGetTotalFilesCount(instance, logger);
python
from ctypes import CDLL, c_int, c_int64

ola = CDLL("OLAPlug_x64.dll")
ola.CreateCOLAPlugInterFace.restype = c_int64
instance = ola.CreateCOLAPlugInterFace()
logger = 0

ola.LogSetBaseDirectory(instance, logger, b"D:\\logs")
ola.LogSetFileNamePattern(instance, logger, b"app_{date}_{index}.log")
ola.LogSetMaxFiles(instance, logger, 20)
ret = ola.LogCleanupOldFiles(instance, logger, -1)
print("total files:", ola.LogGetTotalFilesCount(instance, logger))

返回值 ​

返回值说明
1成功。
0失败。

注意事项 ​

项目说明
参数 keepCount 为 -1 时参数 keepCount 为 -1 时，使用 LogSetMaxFiles 设置的值（默认10个）。
清理规则按文件修改时间排序，删除最旧的文件。
当前正在使用的日志文件不会被删除当前正在使用的日志文件不会被删除。
只清理与当前日志实例相关的文件只清理与当前日志实例相关的文件。
清理操作是安全的清理操作是安全的，不会影响正在写入的日志。