OLA 文档中心

主题

2026-06-18

设置日志格式 - LogSetPattern ​

函数简介 ​

设置日志的输出格式，支持多种占位符自定义日志样式。

接口名称 ​

LogSetPattern

DLL调用 ​

c
int32_t LogSetPattern(int64_t instance, int64_t loggerHandle, const char* logPattern);

参数说明 ​

参数名类型说明
instance长整数型OLAPlug对象的指针，由 CreateCOLAPlugInterFace 接口生成。
loggerHandle长整数型日志实例句柄（0 表示默认实例）。
logPattern字符串日志格式（为空则使用默认格式）。

支持的占位符 ​

占位符说明
%Y年份（4位数字，如 2026）
%y年份（2位数字，如 26）
%m月份（01-12）
%d日期（01-31）
%H小时（00-23，24小时制）
%I小时（01-12，12小时制）
%M分钟（00-59）
%S秒（00-59）
%e毫秒（000-999）
%f微秒（000000-999999）
%F纳秒（000000000-999999999）
%pAM/PM 标识
%TISO 8601 时间格式（HH:MM:SS）
%v日志消息内容
%l日志级别（TRACE, DEBUG, INFO, WARN, ERROR, CRITICAL）
%L日志级别简写（T, D, I, W, E, C）
%n日志记录器名称
%t线程ID
%P进程ID
%s源文件名
%g源文件短名称（不含路径）
%#源代码行号
%!函数名
%^颜色范围开始标记
%$颜色范围结束标记

示例 ​

SDK 调用 ​

cpp
#include "OLAPlugServer.h"

OLAPlugServer ola;
int ret = ola.LogSetPattern(0, "value");
if (ret == 1) {
    // 操作成功
}
csharp
using OLAPlug;

var ola = new OLAPlugServer();
int ret = ola.LogSetPattern(0, "value");
if (ret == 1)
{
    // 操作成功
}
python
from OLAPlugServer import OLAPlugServer

ola = OLAPlugServer()
ret = ola.LogSetPattern(0, "value")
if ret == 1:
    pass  # 操作成功
java
import com.olaplug.OLAPlugServer;

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

OLAPlugServer ola;
int32_t ret = ola.LogSetPattern(0, "value");
if (ret == 1) {
    // 操作成功
}

原生 DLL 调用 ​

cpp
LogSetPattern(instance, 0, "value");
csharp
using System.Runtime.InteropServices;
using System.Text;

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

LogSetPattern(instance, 0, "value");
python
from ctypes import CDLL, c_int, c_int64, create_string_buffer

ola = CDLL("OLAPlug_x64.dll")
ola.CreateCOLAPlugInterFace.restype = c_int64
ola.LogSetPattern(instance, 0, "value")

返回值 ​

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

注意事项 ​

项目说明
默认格式[%Y-%m-%d %H:%M:%S.%e] [%^%l%$] %v。
修改后立即生效修改后立即生效，如果日志系统已初始化，会自动重新初始化。
%^ 和 %$ 用于控制颜色范围%^ 和 %$ 用于控制颜色范围，仅在控制台输出时有效。
占位符区分大小写占位符区分大小写。
格式格式字符串基于 spdlog 库的格式规范。