ConfigureAxisEx

用于配置虚拟轴的相关设定，并将该轴关联到自订虚拟马达。此函式可在下列状态下使用：

• 子系统建立之后
• 子系统启动之后

语法

KsError ConfigureAxisEx(
     int Index,
     SlaveStatus Detail,
     int Resolution,
     BOOL UseCustomMotor,
     int LibraryId
);

参数

Index [in]：虚拟轴的索引。索引以 0 为起始，不支援别名。

Detail [in]：包含用于设定虚拟轴的相关资讯，可设定项目如下：

• Name
• VendorId
• ProductCode
• RevisionNumber
• SerialNumber
• InputLength
• OutputLength

Resolution [in]：虚拟轴使用的编码器解析度。

UseCustomMotor [in]：BOOL 旗标，指示是否使用自订虚拟马达。

• TRUE：必须指定有效的 LibraryId ，该 ID 可透过 LoadCustomMotorLibrary 取得。
• FALSE：使用 KINGSTAR Runtime 的预设虚拟马达，LibraryId 会被忽略。

LibraryId [in]：自订虚拟马达实作的 ID。当 UseCustomMotor 设为 TRUE 时，必须指定有效值。此 ID 可透过 LoadCustomMotorLibrary 取得。

回传值

若此函式执行成功，会回传 errNoError，否则会传回错误码。如需更多有关错误码的资讯，请参阅 KsError 清单。

可能的错误码：

错误码	说明
errSubsystemNotRunning	在子系统尚未建立时使用此函式。
errWrongParameter	发生下列其中一种情况： Index 超出范围。 Resolution 小于 0。 UseCustomMotor 设为 TRUE，但 LibraryId 超出范围（小于 0 或大于等于 256）。 UseCustomMotor 设为 TRUE，但与指定 LibraryId 相关联的 RTDLL 尚未载入。 在轴建立后，尝试使用不同的设定重新设定该轴。

备注

• ConfigureAxisEx 在 RTSS 配置下并非执行绪安全（thread-safe）。

使用需求

	RT	Win32
最低支援版本	4.5.4	4.5.4
标头档	CustomSimulatedMotorApi.h	CustomSimulatedMotorApi.h
程式库	KsApi_Rtss.lib	KsApi.lib

参见

自订虚拟马达

GetAxisMotorType

LoadCustomMotorLibrary