KsCommandStatus

The states of a KINGSTAR function.

Name Type Meaning
Handle HANDLE Used to uniquely identify a command.
Value PVOID Reserved for internal use. For the commands that return a value, it is a copy of a pointer to which the value will be copied once the command is done.
ValueLength INT The length of the value buffer.
Done BOOL The function has done its work.
InSync BOOL TRUE: the synchronization is completed. FALSE: the slave axis is synchronizing with the master axis.
InVelocity BOOL The commanded velocity reached.
Busy BOOL The command is not finished and new output values are to be expected.
Active BOOL The command is controlling the axis.
CommandAborted BOOL The command is aborted by another function.
Error BOOL Signals that an error has occurred within the command.
ErrorId KsError The error identification.