mpiControlSampleRate
Declaration
int32_t mpiControlSampleRate(MPIControl control, double *sampleRate)
Required Header: stdmpi.h
Description
mpiControlSampleRate writes the current sample rate (Hz) of the controller’s processor to the address pointed to by sampleRate. This is the same value returned in MPIControlTimingConfig.sampleRate after mpiControlTimingConfigGet(...) was performed, but is also provided as this separate method to avoid the extra processing overhead of mpiControlTimingConfigGet
| control | a handle to the Control object |
|---|---|
| *sampleRate | pointer to a double where the current sample rate will be stored. |
| Return Values | |
|---|---|
| MPIMessageOK | |
| MPIControlMessageFIRMWARE_VERSION_NONE | |
| MPIControlMessageFIRMWARE_VERSION | |
See Also
MPIControlTimingConfig | mpiControlTimingConfigGet | mpiControlTimingConfigSet