OLA 文档中心

主题

2026-08-20

手动触发文件分割 - LogRotateFile ​

函数简介 ​

手动触发日志文件分割，立即关闭当前文件并创建新文件。

接口名称 ​

LogRotateFile

DLL调用 ​

c
int32_t LogRotateFile(int64_t instance, int64_t loggerHandle);

参数说明 ​

参数名类型说明
instance长整数型OLAPlug对象的指针，由 CreateCOLAPlugInterFace 接口生成。
loggerHandle长整数型日志实例句柄（0 表示默认实例）。

示例 ​

文件名含 {index}，写入后手动 LogRotateFile，再用 LogGetCurrentFilePath 查看新文件。

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.LogInfo("before rotate");
int ret = ola.LogRotateFile(logger);
if (ret != 1) {
    return;
}
ola.LogInfo("after rotate");
std::string path = ola.LogGetCurrentFilePath(logger);
std::printf("current log file: %s\n", path.c_str());
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.LogInfo("before rotate");
int ret = ola.LogRotateFile(logger);
if (ret != 1) return;
ola.LogInfo("after rotate");
string path = ola.LogGetCurrentFilePath(logger);
Console.WriteLine("current log file: " + path);
python
from OLAPlugServer import OLAPlugServer

ola = OLAPlugServer()
logger = 0

ola.LogSetBaseDirectory(logger, r"D:\logs")
ola.LogSetFileNamePattern(logger, "app_{date}_{index}.log")
ola.LogInfo("before rotate")
ret = ola.LogRotateFile(logger)
if ret != 1:
    raise RuntimeError("failed")
ola.LogInfo("after rotate")
path = ola.LogGetCurrentFilePath(logger)
print("current log file:", path)
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.LogInfo("before rotate");
int ret = ola.LogRotateFile(logger);
if (ret != 1) {
    return;
}
ola.LogInfo("after rotate");
String path = ola.LogGetCurrentFilePath(logger);
System.out.println("current log file: " + path);
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.LogInfo("before rotate")
ret := ola.LogRotateFile(logger)
if ret != 1 {
    return
}
ola.LogInfo("after rotate")
path := ola.LogGetCurrentFilePath(logger)
fmt.Println("current log file:", path)
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_info("before rotate");
let ret = ola.log_rotate_file(logger);
if ret != 1 {
    return;
}
ola.log_info("after rotate");
let path = ola.log_get_current_file_path(logger);
println!("current log file: {}", path);
cpp
var ola = com("OlaPlug.OlaSoft")
var logger = 0

ola.LogSetBaseDirectory(logger, "D:\\logs")
ola.LogSetFileNamePattern(logger, "app_{date}_{index}.log")
ola.LogInfo("before rotate")
var ret = ola.LogRotateFile(logger)
if(ret == 1) {
    ola.LogInfo("after rotate")
    var path = ola.LogGetCurrentFilePath(logger)
    traceprint("current log file: " + path)
}
vbscript
Set ola = CreateObject("OlaPlug.OlaSoft")
logger = 0

ola.LogSetBaseDirectory logger, "D:\logs"
ola.LogSetFileNamePattern logger, "app_{date}_{index}.log"
ola.LogInfo "before rotate"
ret = ola.LogRotateFile(logger)
If ret = 1 Then
    ola.LogInfo "after rotate"
    path = ola.LogGetCurrentFilePath(logger)
    TracePrint "current log file: " & path
End If
text
.局部变量 ola, OLAPlug
.局部变量 ret, 整数型
.局部变量 logger, 长整数型
.局部变量 path, 文本型

ola.Create ()
logger ＝ 0

ola.LogSetBaseDirectory (logger, “D:\logs”)
ola.LogSetFileNamePattern (logger, “app_{date}_{index}.log”)
ola.LogInfo (“before rotate”)
ret ＝ ola.LogRotateFile (logger)
.如果真 (ret ＝ 1)
    ola.LogInfo (“after rotate”)
    path ＝ ola.LogGetCurrentFilePath (logger)
    调试输出 (“current log file：”, path)
.如果真结束
aardio
import OLAPlugServer;
var ola = OLAPlugServer();
var logger = 0;

ola.LogSetBaseDirectory(logger, "D:\\logs");
ola.LogSetFileNamePattern(logger, "app_{date}_{index}.log");
ola.LogInfo("before rotate");
var ret = ola.LogRotateFile(logger);
if(ret == 1){
    ola.LogInfo("after rotate");
    var path = ola.LogGetCurrentFilePath(logger);
    io.print("current log file: ", path);
}
text
变量 ola <类型 = OLAPlugServer>
ola = 新建 OLAPlugServer
长整数 logger = 0

ola.LogSetBaseDirectory(logger, "D:\\logs")
ola.LogSetFileNamePattern(logger, "app_{date}_{index}.log")
ola.LogInfo("before rotate")
整数 ret = ola.LogRotateFile(logger)
如果真 (ret ＝ 1)
{
    ola.LogInfo("after rotate")
    文本 path = ola.LogGetCurrentFilePath(logger)
    调试输出 ("current log file：", path)
}
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.LogInfo("before rotate");
int32_t ret = ola.LogRotateFile(logger);
if (ret != 1) {
    return;
}
ola.LogInfo("after rotate");
std::string path = ola.LogGetCurrentFilePath(logger);
std::printf("current log file: %s\n", path.c_str());

原生 DLL 调用 ​

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

LogSetBaseDirectory(instance, logger, "D:\\logs");
LogSetFileNamePattern(instance, logger, "app_{date}_{index}.log");
LogInfo(instance, "before rotate");
int ret = LogRotateFile(instance, logger);
if (ret != 1) {
    return;
}
LogInfo(instance, "after rotate");
// LogGetCurrentFilePath → index 递增后的新文件
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 LogInfo(long ola, string message);
[DllImport("OLAPlug_x64.dll", CallingConvention = CallingConvention.StdCall)]
static extern int LogRotateFile(long ola, long loggerHandle);

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

LogSetBaseDirectory(instance, logger, @"D:\logs");
LogSetFileNamePattern(instance, logger, "app_{date}_{index}.log");
LogInfo(instance, "before rotate");
int ret = LogRotateFile(instance, logger);
if (ret != 1) return;
LogInfo(instance, "after rotate");
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.LogInfo(instance, b"before rotate")
ret = ola.LogRotateFile(instance, logger)
if ret != 1:
    raise RuntimeError("LogRotateFile failed")
ola.LogInfo(instance, b"after rotate")

返回值 ​

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

注意事项 ​

项目说明
立即关闭当前文件并创建新文件立即关闭当前文件并创建新文件。
不受 LogSetRotationMode不受 LogSetRotationMode 设置的影响，可以随时手动触发。
LogSetFileNamePattern新文件名会根据 LogSetFileNamePattern 的设置生成。
如果使用了 {index} 占位符如果使用了 {index} 占位符，序号会自动递增。
LogSetMaxFiles分割后会自动清理超过保留数量的旧文件（根据 LogSetMaxFiles 设置）。