OLA 文档中心

主题

2026-06-18

读取用户自定义设置 - GetConfig ​

函数简介 ​

读取用户自定义设置，返回匹配配置项的JSON字符串。

接口名称 ​

GetConfig

DLL调用 ​

long GetConfig(long ola, string configKey);

参数说明 ​

参数名类型说明
ola长整数型OLAPlug对象的指针，由 CreateCOLAPlugInterFace 接口生成。
configKey字符串配置项名称。留空 时返回当前实例可读的 全部 配置 JSON；指定键名时返回单键 JSON，如 {"EnableRealMouse":true}。键名大小写不敏感。

示例 ​

SDK 调用 ​

cpp
#include "OLAPlugServer.h"

OLAPlugServer ola;
std::string result = ola.GetConfig("value");
csharp
using OLAPlug;

var ola = new OLAPlugServer();
string result = ola.GetConfig("value");
python
from OLAPlugServer import OLAPlugServer

ola = OLAPlugServer()
result = ola.GetConfig("value")
java
import com.olaplug.OLAPlugServer;

OLAPlugServer ola = new OLAPlugServer();
String result = ola.GetConfig("value");
cpp
var ola = com("OlaPlug.OlaSoft")
var result = ola.GetConfig("value")
vbscript
Set ola = CreateObject("OlaPlug.OlaSoft")
result = ola.GetConfig("value")
text
.局部变量 ola, OLAPlug
ola.创建 ()
result ＝ ola.GetConfig(“value”)
aardio
import OLAPlugServer;
var ola = OLAPlugServer();
var result = ola.GetConfig("value");
text
变量 ola <类型 = OLAPlugServer>
ola = 新建 OLAPlugServer
文本型 result = ola.GetConfig("value")
cpp
#include "OLAPlugServer.h"

OLAPlugServer ola;
std::string result = ola.GetConfig("value");

原生 DLL 调用 ​

cpp
long instance = CreateCOLAPlugInterFace();
long ptr = GetConfig(instance, "value");
if (ptr != 0) {
    char buffer[512] = {0};
    GetStringFromPtr(ptr, buffer, sizeof(buffer));
    FreeStringPtr(ptr);
}
csharp
using System.Runtime.InteropServices;
using System.Text;

[DllImport("OLAPlug_x64.dll", CallingConvention = CallingConvention.StdCall)]
static extern long CreateCOLAPlugInterFace();
[DllImport("OLAPlug_x64.dll", CallingConvention = CallingConvention.StdCall)]
static extern int GetStringFromPtr(long ptr, StringBuilder lpString, int size);
[DllImport("OLAPlug_x64.dll", CallingConvention = CallingConvention.StdCall)]
static extern int FreeStringPtr(long ptr);
[DllImport("OLAPlug_x64.dll", CallingConvention = CallingConvention.StdCall)]
static extern int GetStringSize(long ptr);
[DllImport("OLAPlug_x64.dll", CallingConvention = CallingConvention.StdCall)]
static extern long GetConfig(long ola, string configKey);

long instance = CreateCOLAPlugInterFace();
long ptr = GetConfig(instance, "value");
if (ptr != 0) {
    StringBuilder sb = new StringBuilder(GetStringSize(ptr) + 1);
    GetStringFromPtr(ptr, sb, sb.Capacity);
    FreeStringPtr(ptr);
    string result = sb.ToString();
}
python
from ctypes import CDLL, c_int, c_int64, create_string_buffer

ola = CDLL("OLAPlug_x64.dll")
ola.CreateCOLAPlugInterFace.restype = c_int64
instance = ola.CreateCOLAPlugInterFace()
ptr = ola.GetConfig(instance, "value")
if ptr:
    buf = create_string_buffer(512)
    ola.GetStringFromPtr(ptr, buf, 512)
    ola.FreeStringPtr(ptr)
    result = buf.value.decode("utf-8")

返回值 ​

返回值说明
（字符串指针）JSON 字符串：configKey 为空时为完整配置对象；指定键时为 {"键名": 值}。未知名称返回空字符串。

返回示例（configKey 为空） ​

json
{
  "EnableRealKeypad": false,
  "EnableRealMouse": true,
  "KeyDownInterval": 50,
  "MouseClickInterval": 50,
  "MouseDoubleClickInterval": 200,
  "MouseDriftCheckTime": 0,
  "RealMouseMode": 6,
  "SnapPrefetchInterval": 33,
  "YoloAutoWarmup": true,
  "YoloAutoWarmupIterations": 2,
  "YoloRegionSortMode": 0,
  "WorkPath": "",
  "DefaultReturnEncoding": 1
}

返回示例（configKey = "YoloAutoWarmup"） ​

json
{
  "YoloAutoWarmup": true
}

可读配置项 ​

与 SetConfig 文档 「可用配置项」 所列字段一致，包括：

  • 实例级：键鼠轨迹、VNC/RDP、截图预取、输入锁定等
  • 全局：编码、路径/数据库、YOLO 预热与排序、绑定模式、找窗/VMware 等

完整键名、类型、默认值与说明见 SetConfig 页各分类表格。单键读取示例：

text
GetConfig("")                    // 全部
GetConfig("EnableRealMouse")     // 单键
GetConfig("YoloAutoWarmupIterations")

注意事项 ​

项目说明
释放内存DLL调用返回字符串指针地址，需要调用 FreeStringPtr 接口释放内存。
相关接口写入配置请使用 SetConfig 或 SetConfigByKey。
类型说明布尔/数值在 SetConfig 中支持字符串形式；GetConfig 返回 JSON 原生类型（布尔为 true/false）。