Indy 9 | Content | Index | Reference

SetLocalTime
Unit: IdGlobal
Updates the time on the local computer.

    function SetLocalTime(Value: TDateTime): boolean;

Unit
IdGlobal
Parameters
Value: TDateTime
The date and time to use for the local computer.
Return Value
Boolean - True when the local computer date is updated.
Description
SetLocalTime is a Boolean function used to update the time on the local computer system using the TDateTime value in Value.

SetLocalTime is used by Indy time synchronization components like TIdSNTP and TIdTime.

SetLocalTime encapsulates the platform-specific procedures and functions used to update the time on the local computer system. For the Windows platform, the procedure used is Windows.SetLocalTime. On the Linux platform, SetLocalTime performs no operation and always returns False.

Created with Doc-O-Matic 2 donated to Project JEDI. Commercial license available from the Doc-O-Matic site.