iscEngineGetPref()

用途

iscEngineGetPref() 检索当前首选项设置。

语法 

isy_INT32 iscEngineGetPref(
    HISCENG              hEngine,
    isy_CONST isy_INT32  prefID,
    isy_TCHAR           *prefVal,
    isy_CONST isy_INT32  prefLen);

函数自变量

表 148 列示用于 iscEngineGetPref() 函数的有效自变量。

表 148. iscEngineGetPref() 自变量

数据类型 自变量 使用 描述
HISCENG hEngine 输入 同步引擎的句柄
isy_CONST isy_INT32 prefID 输入 首选项标识，它具有下列值之一：
  • ISCPREF_Timeout：接收消息的超时长度
  • ISCPREF_Trace：详细跟踪。
isy_TCHAR* prefVal 输出 指向用来存储返回的首选值的缓冲区的指针。有某些预定义的首选项常量。

对于 ISCPREF_Trace 首选项：

  • ISCCONST_TraceON：打开详细的调试跟踪
  • ISCCONST_TraceOFF：关闭详细的调试跟踪

对于 ISCPREF_Timeout 首选项：

  • ISCCONST_TimeoutNever：等待服务器应答时从不超时。
  • ISCCONST_TimeoutMinimum：最小超时长度
isy_CONST isy_INT32 prefLen 输入 提供的缓冲区的大小（prefVal）

用法

使用 iscEngineGetPref() 获取同步引擎的首选项设置（它是缺省值或由 iscEngineSetPref() 设置的值）。

返回码

限制

提供的缓冲区应足够大，以存储各种首选项的值：

相关概念

相关任务

相关参考