Admin Production ni-theme
Current Publication

CVIAbsoluteTimeFromLocalCalendar

LabWindows/CVI

CVIAbsoluteTimeFromLocalCalendar

int CVIAbsoluteTimeFromLocalCalendar (unsigned int year, unsigned int month, unsigned int day, unsigned int hour, unsigned int minute, unsigned int second, double millisecond, CVIAbsoluteTime *absoluteTime);

Purpose

Converts local calendar time components to a LabWindows/CVI absolute time value using the current time zone setting for your system.

This function cannot convert the following Coordinated Universal Time (UTC) time values:

  • Time values before the year 1970 on Linux or in applications running on an RT target
  • Time values before the year 1601 on Windows operating systems

(RT) You can set time zone settings for RT systems in MAX.

Parameters

Input
Name Type Description
year unsigned int The year in local calendar time.

Values before the year 1970 are not supported on Linux or in applications running on an RT target. Values before the year 1601 are not supported on Windows operating systems.
month unsigned int The month in local calendar time. Valid values are 1 (January) to 12 (December).
day unsigned int The date of the month in local calendar time. Valid values are 1 to 31.
hour unsigned int The hour in local calendar time. Valid values are 0 to 23.
minute unsigned int The minute in local calendar time. Valid values are 0 to 59.
second unsigned int The second in local calendar time. Valid values are 0 to 59.
millisecond double The millisecond in local calendar time. You can specify only non-negative values that are less than 1,000.
Output
Name Type Description
absoluteTime CVIAbsoluteTime Absolute time value in National Instruments Binary Time Format.

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