mpiControlResetToDefault
Definition
MPI_DECL1 MPI_RESULT MPI_DECL2 mpiControlResetToDefault(MPIControl control);
Required Header: stdmpi.h
Change History: Added in 04.00.
Description
mpiControlResetToDefault effectively resets the controller, setting the controller's RAM memory to default values. The controller's RAM memory is not loaded from firmware settings.
To erase the object configurations from the controller, you must call mpiControlResetToDefault, followed by mpiControlFlashSaveAll.
Note: the sample counter will not be reset from a call to mpiControlResetToDefault. Other than where the controller's RAM memory receives its new values, this is the major difference between mpiControlResetToDefault and mpiControlReset.
| control | The controller on which the RAM memory will be reset to default values. |
|---|
| Return Values |
|---|
| MPIMessageOK |
Sample Code
/* Erase all configurations from flash memory */ void eraseFlashMemoryConfigurations(MPIControl control) { MPI_RESULT returnValue = mpiControlResetToDefault(control); msgCHECK(returnValue); returnValue = mpiControlFlashSaveAll(control, NULL, NULL); msgCHECK(returnValue); }