OLA 文档中心

主题

2026-06-18

设置文件名模式 - LogSetFileNamePattern ​

函数简介 ​

设置日志文件的命名模式，支持多种占位符实现动态文件命名。

接口名称 ​

LogSetFileNamePattern

DLL调用 ​

c
int32_t LogSetFileNamePattern(int64_t instance, int64_t loggerHandle, const char* fileNamePattern);

参数说明 ​

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

支持的占位符 ​

占位符说明示例
当前日期（YYYY-MM-DD）2026-03-02
当前时间（HH-MM-SS）14-30-45
日期时间（YYYY-MM-DD_HH-MM-SS）2026-03-02_14-30-45
模块名称（通过 LogSetModuleName 设置）network
日志级别INFO
文件序号（从 1 开始递增）1, 2, 3...
进程ID12345
年份（4位数字）2026
月份（01-12）03
日期（01-31）02
小时（00-23）14
分钟（00-59）30
秒（00-59）45

示例 ​

SDK 调用 ​

cpp
#include "OLAPlugServer.h"

OLAPlugServer ola;
int ret = ola.LogSetFileNamePattern(0, "C:\\test.txt");
if (ret == 1) {
    // 操作成功
}
csharp
using OLAPlug;

var ola = new OLAPlugServer();
int ret = ola.LogSetFileNamePattern(0, "C:\\test.txt");
if (ret == 1)
{
    // 操作成功
}
python
from OLAPlugServer import OLAPlugServer

ola = OLAPlugServer()
ret = ola.LogSetFileNamePattern(0, "C:\\test.txt")
if ret == 1:
    pass  # 操作成功
java
import com.olaplug.OLAPlugServer;

OLAPlugServer ola = new OLAPlugServer();
int ret = ola.LogSetFileNamePattern(0, "C:\\test.txt");
if (ret == 1) {
    // 操作成功
}
cpp
var ola = com("OlaPlug.OlaSoft")
var ret = ola.LogSetFileNamePattern(0, "C:\\test.txt")
if(ret == 1) {
    // 操作成功
}
vbscript
Set ola = CreateObject("OlaPlug.OlaSoft")
ret = ola.LogSetFileNamePattern(0, "C:\\test.txt")
If ret = 1 Then
    ' 操作成功
End If
text
.局部变量 ola, OLAPlug
ola.创建 ()
ret ＝ ola.LogSetFileNamePattern(0, “C:\\test.txt”)
.如果真 (ret ＝ 1)
    ' 操作成功
.如果真结束
aardio
import OLAPlugServer;
var ola = OLAPlugServer();
var ret = ola.LogSetFileNamePattern(0, "C:\\test.txt");
if(ret == 1){
    // 操作成功
}
text
变量 ola <类型 = OLAPlugServer>
ola = 新建 OLAPlugServer
整数 ret = ola.LogSetFileNamePattern(0, "C:\\test.txt")
如果真 (ret ＝ 1)
{
    // 操作成功
}
cpp
#include "OLAPlugServer.h"

OLAPlugServer ola;
int32_t ret = ola.LogSetFileNamePattern(0, "C:\\test.txt");
if (ret == 1) {
    // 操作成功
}

原生 DLL 调用 ​

cpp
LogSetFileNamePattern(instance, 0, "C:\\test.txt");
csharp
using System.Runtime.InteropServices;
using System.Text;

[DllImport("OLAPlug_x64.dll", CallingConvention = CallingConvention.StdCall)]
static extern int LogSetFileNamePattern(long ola, int loggerHandle, string fileNamePattern);

LogSetFileNamePattern(instance, 0, "C:\\test.txt");
python
from ctypes import CDLL, c_int, c_int64, create_string_buffer

ola = CDLL("OLAPlug_x64.dll")
ola.CreateCOLAPlugInterFace.restype = c_int64
ola.LogSetFileNamePattern(instance, 0, "C:\\test.txt")

返回值 ​

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

注意事项 ​

项目说明
默认值app.log。
文件分割时文件分割时，如果模式中包含 {index}，会自动递增序号。
如果模式中不包含 {index}如果模式中不包含 {index}，分割时会自动在文件名后添加序号。
修改后立即生效修改后立即生效，如果日志系统已初始化，会自动重新初始化。
建议避免使用操作系统不支持的特殊字符建议避免使用操作系统不支持的特殊字符。
占位符区分大小写占位符区分大小写，必须使用小写字母。