|
DateTimeExtensionsTimeIsValid Method
|
Determines if time is valid, by comparing it to the specified current time.
Namespace: GSFAssembly: GSF.Core (in GSF.Core.dll) Version: 2.4.207-beta+1781b796b2aa7a54013a031eb432fe4ccee31867
Syntax GSF.DateTimeExtensions.TimeIsValid = function(testTime, currentTime, lagTime, leadTime);
View SourceParameters
- testTime DateTime
- Time to test for validity.
- currentTime DateTime
- Specified current time (e.g., could be Date.Now or Date.UtcNow).
- lagTime Double
- The allowed lag time, in seconds, before assuming time is too old to be valid.
- leadTime Double
- The allowed lead time, in seconds, before assuming time is too advanced to be
valid.
Return Value
BooleanTrue, if time is within the specified range.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type
DateTime. When you use instance method syntax to call this method, omit the first parameter. For more information, see
Extension Methods (Visual Basic) or
Extension Methods (C# Programming Guide).
Exceptions Remarks Time is considered valid if it exists within the specified lag time/lead time range of current
time.
Note that lag time and lead time must be greater than zero, but can be set to sub-second
intervals.
See Also