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