Skip to content

设置模块名称 - LogSetModuleName

函数简介

设置日志实例的模块名称,用于目录组织和文件命名。

接口名称

LogSetModuleName

DLL调用

c
int32_t LogSetModuleName(int64_t instance, int64_t loggerHandle, const char* moduleName);

参数说明

参数名类型说明
instance长整数型OLAPlug对象的指针,由 CreateCOLAPlugInterFace 接口生成。
loggerHandle长整数型日志实例句柄(0 表示默认实例)。
moduleName字符串模块名称(用于目录组织)。

示例

模块名供 {module} 占位符与 DirMode=MODULE 使用。

SDK 调用

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

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

ola.LogSetBaseDirectory(logger, "D:\\logs");
int ret = ola.LogSetModuleName(logger, "network");
if (ret != 1) {
    return;
}
ola.LogSetFileNamePattern(logger, "{module}_{date}.log"); // 展开如 network_2026-03-02.log
ola.LogInfo("module=network");
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");
int ret = ola.LogSetModuleName(logger, "network");
if (ret != 1) return;
ola.LogSetFileNamePattern(logger, "{module}_{date}.log"); // 展开如 network_2026-03-02.log
ola.LogInfo("module=network");
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")
ret = ola.LogSetModuleName(logger, "network")
if ret != 1:
    raise RuntimeError("failed")
ola.LogSetFileNamePattern(logger, "{module}_{date}.log")  # 展开如 network_2026-03-02.log
ola.LogInfo("module=network")
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");
int ret = ola.LogSetModuleName(logger, "network");
if (ret != 1) {
    return;
}
ola.LogSetFileNamePattern(logger, "{module}_{date}.log"); // 展开如 network_2026-03-02.log
ola.LogInfo("module=network");
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`)
ret := ola.LogSetModuleName(logger, "network")
if ret != 1 {
    return
}
ola.LogSetFileNamePattern(logger, "{module}_{date}.log") // 展开如 network_2026-03-02.log
ola.LogInfo("module=network")
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");
let ret = ola.log_set_module_name(logger, "network");
if ret != 1 {
    return;
}
ola.log_set_file_name_pattern(logger, "{module}_{date}.log"); // 展开如 network_2026-03-02.log
ola.log_info("module=network");
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")
var ret = ola.LogSetModuleName(logger, "network")
if(ret == 1) {
    ola.LogSetFileNamePattern(logger, "{module}_{date}.log") // 展开如 network_2026-03-02.log
    ola.LogInfo("module=network")
    var path = ola.LogGetCurrentFilePath(logger)
    traceprint("current log file: " + path)
}
vbscript
Set ola = CreateObject("OlaPlug.OlaSoft")
logger = 0

ola.LogSetBaseDirectory logger, "D:\logs"
ret = ola.LogSetModuleName(logger, "network")
If ret = 1 Then
    ola.LogSetFileNamePattern logger, "{module}_{date}.log"
    ola.LogInfo "module=network"
    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”)
ret = ola.LogSetModuleName (logger, “network”)
.如果真 (ret = 1)
    ola.LogSetFileNamePattern (logger, “{module}_{date}.log”)  ' 展开如 network_2026-03-02.log
    ola.LogInfo (“module=network”)
    path = ola.LogGetCurrentFilePath (logger)
    调试输出 (“current log file:”, path)
.如果真结束
aardio
import OLAPlugServer;
var ola = OLAPlugServer();
var logger = 0;

ola.LogSetBaseDirectory(logger, "D:\\logs");
var ret = ola.LogSetModuleName(logger, "network");
if(ret == 1){
    ola.LogSetFileNamePattern(logger, "{module}_{date}.log"); // 展开如 network_2026-03-02.log
    ola.LogInfo("module=network");
    var path = ola.LogGetCurrentFilePath(logger);
    io.print("current log file: ", path);
}
text
变量 ola <类型 = OLAPlugServer>
ola = 新建 OLAPlugServer
长整数 logger = 0

ola.LogSetBaseDirectory(logger, "D:\\logs")
整数 ret = ola.LogSetModuleName(logger, "network")
如果真 (ret = 1)
{
    ola.LogSetFileNamePattern(logger, "{module}_{date}.log")  ' 展开如 network_2026-03-02.log
    ola.LogInfo("module=network")
    文本 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");
int32_t ret = ola.LogSetModuleName(logger, "network");
if (ret != 1) {
    return;
}
ola.LogSetFileNamePattern(logger, "{module}_{date}.log"); // 展开如 network_2026-03-02.log
ola.LogInfo("module=network");
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");
int ret = LogSetModuleName(instance, logger, "network");
if (ret != 1) {
    return;
}
LogSetFileNamePattern(instance, logger, "{module}_{date}.log");
LogInfo(instance, "module=network");
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 LogSetModuleName(long ola, long loggerHandle, string moduleName);
[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);

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

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

返回值

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

注意事项

项目说明
OLA_LOG_DIR_BY_MODULE用于 OLA_LOG_DIR_BY_MODULE 目录模式。
可在文件名模式中使用 {module} 占位可在文件名模式中使用 {module} 占位符。
修改后立即生效修改后立即生效,如果日志系统已初始化,会自动重新初始化。
使用英文字母、数字和下划线建议使用英文字母、数字和下划线,避免特殊字符。
不同的日志实例可以设置不同的模块名称不同的日志实例可以设置不同的模块名称,实现日志分类管理。