mpiControlStatus

Declaration

MPI_RESULT
   mpiControlStatus(MPIControl          control,
                    MPIControlStatus    *status);

 

Required Header: Control.h

Change History: Added in 04.00.

Description

mpiControlStatus reads the control object status from the controller and writes it into the structure pointed to by status.

control A handle to a control object.
*nearestRate A pointer the status structure
Return Values
MPIMessageOK
MPIControlMessageOBJECT_INVALID

Sample Code

MPIControlStatus controlStatus;

returnValue = mpiControlStatus(control, &controlStatus);
if (returnValue == MPIMessageOK) { mpiPlatformConsole("Fan Status: 0x%x\n\n", controlStatus.fanStatus); }