KS_setClockSource
The function KS_setClockSource modifies a specific clock.
C/C++
Error KS_setClockSource(const KSClockSource* pClockSource, uint clockId);
Delphi
function KS_setClockSource(pClockSource: PKSClockSource; clockId: uint): Error;
C#
int KS_setClockSource(ref KSClockSource pClockSource, uint clockId);
Parameters
pClockSource (const KSClockSource*)
Pointer to structure with new clock information.
clockId (uint)
Clock to modify.
Return values
KSERROR_BAD_PARAM | One parameter is wrong. |
KSERROR_FUNCTION_NOT_AVAILABLE | The chosen clock is not available. |
Comments
The changes made for the clock effects the entire system.
The function can be used on kernel-level, including real-time mode.
Example 1
In the following example ….
... int ksError = KS_setClockSource(pClockSource, clockId); ... // error handling ...
Example 2
See smp\ClockSources.
See also
KS_calibrateMachineTime, KS_getSystemTicks, KS_getSystemTime, KS_getMachineTime, KS_getAbsTime, KS_getClock, KS_getClockSource, KS_microDelay, KS_convertClock, const KSClockSource
Contained in: Clock Module
As part of Kithara »RealTime Suite«
Available since: version 7.20
Build date: 2013-04-17
