mpiControlValidSampleRate

Definition

MPI_RESULT
   mpiControlValidSampleRates(MPIControl                  control,
                              MPIControlValidSampleRates  *freqs);

 

Required Header: stdmpi.h

Change History: Added in 04.00.

Description

mpiControlValidSampleRates determines the possible valid sample rates for the controller/SynqNet and writes them into the structure pointed to by freqs.

control A handle to a control object
*frequency A pointer to a structure of valid sample rates
Return Values
MPIMessageOK
MPIControlMessageOBJECT_INVALID

Sample Code

MPIControlValidSampleRates validRates;
int32_t i;

returnValue =
mpiControlValidSampleRates(control, &validRates);

if (returnValue == MPIMessageOK) {
	if (!noRestrictions) {
		for (i = 0; i < frequencyCount; i++) {
    			mpiPlatformConsole("Valid Rate: %lf\n", validRates.freq[i]);
			}
     }
}

See Also

mpiControlNearestValidSampleRate | mpiControlTimingConfigGet | mpiControlTimingConfigSet | Valid Network Sample Rates