showcode "SETTIME" - FreeBASIC Wiki Manual | FBWiki

{{fbdoc item="title" value="SETTIME"}}----
Sets the current system time

{{fbdoc item="syntax"}}##
[[KeyPgDeclare|declare]] [[KeyPgFunction|function]] **Settime** ( [[KeyPgByref|byref]] //newtime// [[KeyPgAs|as]] [[KeyPgConstQualifier|const]] [[KeyPgString|string]] ) [[KeyPgAs|as]] [[KeyPgLong|long]]
##
{{fbdoc item="usage"}}##
//result// = **Settime**( //newtime// )
##
{{fbdoc item="param"}}
##//newtime//##
the new time to set

{{fbdoc item="ret"}}
Returns zero on success or non-zero on failure on all ports except DOS.

{{fbdoc item="desc"}}
To set the time, format the date and send to ##Settime## in one of the following formats: ##"hh:mm:ss"##, ##"hh:mm"##, or ##"hh"## (##hh## is the hour, ##mm## is the minute, and ##ss## is the second).

The error code returned by ##**Settime**## can be checked using ##[[KeyPgErr|Err]]## in the next line. The function version of ##**Settime**## returns directly the error code as a 32 bit ##[[KeyPgLong|Long]]##.

{{fbdoc item="ex"}}
{{fbdoc item="filename" value="examples/manual/system/settime.bas"}}%%(freebasic)
SETTIME "1:20:30"
%%

{{fbdoc item="target"}}
- 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 be run as root/superuser.

{{fbdoc item="diff"}}
- The ##[[KeyPgTime|Time]]## statement was used QB and the syntax was ##TIME = //newtime//##.

{{fbdoc item="see"}}
- ##[[KeyPgTime|Time]]##
- ##[[KeyPgSetdate|Setdate]]##

{{fbdoc item="back" value="CatPgDate|Date and Time Functions"}}