WaitForCommand

等待命令完成。

語法

KsCommandStatus WaitForCommand(
     double Timeout,
     BOOL AbortOnTimeout,
     KsCommandStatus Status
);

參數

Timeout：若未完成命令將被中止的時間段，或必須將 EtherCAT 狀態更改為請求狀態的時間段。其時間單位為秒。

AbortOnTimeout: TRUE: the command will be aborted after the time in Timeout has elapsed.FALSE：命令不會被中止。不管此命令結束與否程式皆繼續運作。

Status：欲等待的命令。可用返回類型為 KsCommandStatus 的命令或返回的 KsCommandStatus 結構來輸入。

回傳值

返回 KsCommandStatus 結構。

備註

• 給 WaitForCommand 的 Status 值不應為空值， 而是另一個如 Start 的命令值。
• 使用 WaitForCommand 等待命令時，若該命令在指定時間段過去前即完成，下一個命令將執行。例如：設定 WaitForCommand(30, TRUE, Start()) 而 Start 在 20 秒內完成， WaitForCommand 將會結束而下一個命令將執行。不會等到 30 秒。

可用的 EtherCAT 狀態

ecatOffline, ecatInit, ecatBoot, ecatPreOP, ecatSafeOP, ecatOP

範例

// Case 1: Directly pass the KsCommandStatus
KsCommandStatus resultStart = WaitForCommand(30, TRUE, Start());

// Case 2: Save the returned KsCommandStatus and then pass to WaitForCommand
KsCommandStatus commandStart = Start();
// Some operation in your application
commandStart = WaitForCommand(30, TRUE, commandStart);

使用需求

參見

AbortCommand

GetCommandStatus