RAD Studio VCL Reference
ContentsIndex
PreviousUpNext
SysUtils.StrToTimeDef Function

Converts a string to a TDateTime value with error default.

Pascal
function StrToTimeDef(const S: string; const Default: TDateTime): TDateTime; overload;
function StrToTimeDef(const S: string; const Default: TDateTime; const FormatSettings: TFormatSettings): TDateTime; overload;
C++
TDateTime StrToTimeDef(const AnsiString S, const TDateTime Default);
TDateTime StrToTimeDef(const AnsiString S, const TDateTime Default, const TFormatSettings FormatSettings);

Call StrToTimeDef to parse a string that specifies a time value. If S does not contain a valid time, StrToTimeDef returns Default.  

The S parameter must consist of two or three numbers, separated by the character defined by the TimeSeparator global variable or its TFormatSettings equivalent, optionally followed by an AM or PM indicator. The numbers represent hour, minute, and (optionally) second, in that order. If the time is followed by AM or PM, it is assumed to be in 12-hour clock format. If no AM or PM indicator is included, the time is assumed to be in 24-hour clock format.  

The first form of StrToTimeDef is not thread-safe, because it uses localization information contained in global variables. The second form of StrToTimeDef, which is thread-safe, refers to localization information contained in the FormatSettings parameter. Before calling the thread-safe form of StrToTimeDef, you must populate FormatSettings with localization information. To populate FormatSettings with a set of default locale values, call GetLocaleFormatSettings

 

Copyright(C) 2009 Embarcadero Technologies, Inc. All Rights Reserved.
What do you think about this topic? Send feedback!