Help Center
Help CenterFreeBASIC

SetDatefunction

Sets the current system date

Date and Time Functionsfunctiondocumented

Syntax

Declare Function SetDate ( ByRef newdate As Const String ) As Long

Parameters

NameDescription
newdatethe new date to set

Return value


Returns zero on success or non-zero on failure on all ports except DOS.

Description


To set the date you just format newdate and send to SetDate in a valid format following one of the following: "mm-dd-yy", "mm-dd-yyyy", "mm/dd/yy", or "mm/dd/yyyy" (mm is the month, dd is the day, yy or yyyy is the year). Two-digit year numbers are based on the year 1900.

The error code returned by SetDate can be checked using Err in the next line. The function version of SetDate returns directly the error code as a 32 bit Long.

Remarks

Usage


result = SetDate( newdate )

Platform Differences


  • On Windows the privilege SE_SYSTEMTIME_NAME is required, which typically means that the calling process has to be run with administrator privileges.
  • On Linux the capability CAP_SYS_TIME is required, which typically means that the calling process has to run as root/superuser.

Differences from QB


  • The DATE statement was used in QB and the syntax was "DATE = string"

See also


Example


Dim m As String, d As String, y As String

m = "03" 'march

d = "13" 'the 13th

y = "1994" 'good ol' days

SetDate m + "/" + d + "/" + y


Reference

  • Documented in KeyPgSetdate.html