SetSystemTime Function

Declare Function SetSystemTime Lib "kernel32.dll" (lpSystemTime As SYSTEMTIME) As Long

Platforms

Windows 95: Supported.
Windows 98: Supported.
Windows NT: Requires Windows NT 3.1 or later.
Windows 2000: Supported.
Windows CE: Requires Windows CE 1.0 or later.

Description & Usage

SetSystemTime sets the date and time of the system's clock. The time given to the function must be in UTC time (Coordinated Universal Time, a.k.a. Greenwich Mean Time (GMT)), not in the system's local time zone.

Return Value

If an error occured, the function returns 0 (use GetLastError to get the error code). If successful, the function returns a non-zero value.

Visual Basic-Specific Issues

None.

Parameters

lpSystemTime: The new time and date to use to set the system clock. The wDayOfWeek member of the structure is ignored.

Example

' This code is licensed according to the terms and conditions listed here.

' Set the system clock to the following time:
' October 3, 1999 16:46:00 UTC
Dim systime As SYSTEMTIME  ' new time and date
Dim retval As Long  ' return value

' Put the date information into the structure.
systime.wYear = 1999
systime.wMonth = 10
systime.wDay = 3
systime.wHour = 16
systime.wMinute = 46
systime.wSecond = 0
systime.wMillisecond = 0

' Set the system clock to that time and date.
retval = SetSystemTime(systime)