Difference between revisions of "TIniFile.ReadTime"
m (→Description) |
m |
||
Line 10: | Line 10: | ||
If it fails to do so for some reason, the ''Default'' value is returned.<br> | If it fails to do so for some reason, the ''Default'' value is returned.<br> | ||
This function is very similar to [[TIniFile.ReadDate|ReadDate]], however, it includes only specific time, not date.<br> | This function is very similar to [[TIniFile.ReadDate|ReadDate]], however, it includes only specific time, not date.<br> | ||
− | '''Important''': Result is a part of a whole day in a decimal part that have passed since 00:00:00 till time under the key in the ini file. Because of that, it's probably a good idea to use [[TIniFile.ReadString|ReadString]] to | + | '''Important''': Result is a part of a whole day in a decimal part that have passed since 00:00:00 till time under the key in the ini file. |
+ | Because of that, it's probably a good idea to use [[TIniFile.ReadString|ReadString]] to read a clarified date. | ||
+ | You could also encode it using one of the available [[:Category:Functions|Functions]] | ||
==Example== | ==Example== |
Revision as of 18:54, 22 August 2013
function ReadDateTime(const Section, Ident: string; Default: TDateTime): TDateTime Section: Section name Ident: Property name (key) Default: Value used as a result when the key has not been found Result: Value of a key (if successful) or Default (if not)
Description
Expand with: make the description more clear |
This function will try to read a TDateTime value from specified section and key
If it fails to do so for some reason, the Default value is returned.
This function is very similar to ReadDate, however, it includes only specific time, not date.
Important: Result is a part of a whole day in a decimal part that have passed since 00:00:00 till time under the key in the ini file. Because of that, it's probably a good idea to use ReadString to read a clarified date. You could also encode it using one of the available Functions
Example
example.ini in soldatserver's root folder
[ModConfig]
Date1=00:00:00
Date2=12:00:00
Date3=13:48:00
script code:
const
// assuming Sandboxed Level < 2
PATH = 'example.ini';
var
Ini: TIniFile;
temp: TDateTime; // could as well be temp: Double;
begin
Ini := File.CreateINI(PATH);
temp := Ini.ReadTime('ModConfig','Date1',0); // temp = 0.0
temp := Ini.ReadTime('ModConfig','Date2',0); // temp = 0.5
temp := Ini.ReadTime('ModConfig','Date3',0); // temp = 0.575
Ini.Free;
end.