Admin Production ni-theme
Current Publication

CVITimeIntervalToFractionalUnitTime

LabWindows/CVI

CVITimeIntervalToFractionalUnitTime

int CVITimeIntervalToFractionalUnitTime (CVITimeInterval interval, CVITimeUnit unit, CVITimeInterval *fractionalTime);

Purpose

Returns the fractional time interval smaller than the time unit in the time interval value.

For example, this function returns a fractional time interval of 0.2 seconds if the input interval is 1.2 seconds and the time unit is seconds. If you specify milliseconds for the time unit and 1.2 seconds as the input interval, CVITimeIntervalToFractionalUnitTime returns a fractional time interval of 0 milliseconds.

Parameters

Input
Name Type Description
interval CVITimeInterval Time interval value in National Instruments Binary Time Format.
unit CVITimeUnit The time unit.

You can specify the following values:

Constant Value
CVITimeUnitAttoseconds CVITimeUnitBase + 30UL
CVITimeUnitFemtoseconds CVITimeUnitBase + 33UL
CVITimeUnitPicoseconds CVITimeUnitBase + 36UL
CVITimeUnitNanoseconds CVITimeUnitBase + 39UL
CVITimeUnit100Nanoseconds CVITimeUnitBase + 41UL
CVITimeUnitMicroseconds CVITimeUnitBase + 42UL
CVITimeUnitMilliseconds CVITimeUnitBase + 45UL
CVITimeUnitSeconds CVITimeUnitBase + 48UL
CVITimeUnitMinutes CVITimeUnitBase + 50UL
CVITimeUnitHours CVITimeUnitBase + 52UL
CVITimeUnitDays CVITimeUnitBase + 54UL

CVITimeUnitBase is defined as 919263177UL - 48UL.
Output
Name Type Description
fractionalTime CVITimeInterval The fractional time interval value smaller than the specified time unit.

Return Value

Name Type Description
status int The result of the function call. Negative values represent errors.

The following table describes the results that this function returns.

Code Constant Description
0 or positive values Success.
–1 kCVITimeInvalidArgumentError An argument passed to the function is invalid.
–2 kCVITimeNullPointerError A NULL pointer was passed to the function instead of a valid memory address.
–3 kCVITimeOverflowError A numerical calculation resulted in an overflow.
–4 kCVITimeDateOutOfRangeError A time value passed to the function is not in the supported range.
–5 kCVITimeOperationFailedError The operation failed due to an unspecified system error.

Additional Information

Library: Utility Library

Include file: utility.h

LabWindows/CVI compatibility: LabWindows/CVI 9.0 and later