GetTimeZoneInformation

This function retrieves the current time-zone parameters. These parameters control the translations between Coordinated Universal Time (UTC) and local time.

DWORD GetTimeZoneInformation(
LPTIME_ZONE_INFORMATION lpTimeZoneInformation); 

Parameters

• lpTimeZoneInformation
  [out] Pointer to a TIME_ZONE_INFORMATION structure to receive the current time-zone parameters.

Return Values

If the function succeeds, the return value is one of the following values:

• TIME_ZONE_ID_UNKNOWN
  The system cannot determine the current time zone. This value is returned if daylight savings time is not used in the current time zone, because there are no transition dates.
• TIME_ZONE_ID_STANDARD
  The system is operating in the range covered by the StandardDate member of the TIME_ZONE_INFORMATION structure.
• TIME_ZONE_ID_DAYLIGHT
  The system is operating in the range covered by the DaylightDate member of the TIME_ZONE_INFORMATION structure.

If the function fails, the return value is TIME_ZONE_ID_INVALID. To get extended error information, call GetLastError.

Remarks

All translations between UTC time and local time are based on the following formula:

UTC = local time + bias 
 

The bias is the difference, in minutes, between UTC time and local time.

If a call to SetTimeZoneInformation supplies a bias value but no transition date, GetTimeZoneInformation will return either TIME_ZONE_ID_STANDARD or TIME_ZONE_ID_DAYLIGHT.

Requirements

Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

See Also

GetLastError, SetTimeZoneInformation, TIME_ZONE_INFORMATION

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.