mpiAxisStatus

Declaration

MPI_RESULT mpiAxisStatus(MPIAxis axis,
                         MPIAixsStatus *status);

Required Header: axis.h
Change History: Changed in 04.00.

Description

mpiAxisStatus reads an Axis’ status from the controller and writes it into the structure pointed to by status.

axis A handle to the Axis object.
*status Pointer to MPIAxisStatus structure.
Return Values
MPIMessageOK
MPIMessageARG_INVALID

Sample Code

Read the axis status and display the status bits.

/* Check motion status for any error conditions */
returnValue =
mpiAxisStatus(axis,
  &status);
msgCHECK(returnValue);

printf("Axis Status: state %d action %d eventMask 0x%x\n"
       "\tatTarget %d settled %d %s\n",
       status.state,
       status.action,
       status.eventMask,
       status.atTarget,
       status.settled,
       (status.settled == FALSE)
               ? "=== NOT SETTLED ==="
               : "");

See Also

MPIAxisStatus | mpiMotionStatus | mpiMotorStatus