IApi.DebugMessage 方法

传送 KINGSTAR 记录档讯息到 KINGSTAR 记录检视。

组合： IntervalZero.KINGSTAR.Base.Api (于 IntervalZero.KINGSTAR.Base.dll) 版本：4.4.0.0

语法

KsError DebugMessage(
       int Category,
       KsLogSeverity Severity,
       string Message,
       bool AppendValues,
       long Value0 = 0,
       long Value1 = 0,
       double Value2 = 0,
       double Value3 = 0
)

Function DebugMessage(
       Category As Integer,
       Severity As KsLogSeverity,
       Message As String,
       AppendValues As Boolean,
       Optional Value0 As Long = 0,
       Optional Value1 As Long = 0,
       Optional Value2 As Double = 0,
       Optional Value3 As Double = 0
) As KsError

参数

Category

型别：int

记录档的 ID，使用者自订义。可使用 SetCategoryName 方法将各 Category 关联一个字串，此 ID 不需从 0 开始或按顺序排列。

Severity

型别：KsLogSeverity

记录档的严重性等级。

Message

型别：string

说明记录档资料的讯息，最多 128 个字元。

AppendValues

型别：bool

true：值有加在 Message 末端。false：值未加在 Message 末端。

Value0

型别：long

显示在记录档的第一个值。

Value1

型别：long

显示在记录档的第二个值。

Value2

型别：double

显示在记录档的第三个值。

Value3

型别：double

显示在记录档的第四个值。

回传值

型别：KsError

方法的回传值。

备注

• Category 与 Severity 可用来筛选欲查看的记录档，筛选会在 KINGSTAR 记录检视 中完成。
• Message 字串使用 UTF-16 编码。
• 若启用 AppendValues，输出的结果为：Message: value0, value1, value2, value3。

可用的 EtherCAT 状态

ecatOffline, ecatInit, ecatBoot, ecatPreOP, ecatSafeOP, ecatOP

范例

N/A

参见

IApi 介面

IntervalZero.KINGSTAR.Base.Api 命名空间