System.SysUtils.TryStrToTime

From Appmethod Libraries
Jump to: navigation, search

Object Pascal

function TryStrToTime(const S: string; out Value: TDateTime): Boolean;
function TryStrToTime(const S: string; out Value: TDateTime; const AFormatSettings: TFormatSettings): Boolean;

C++

extern DELPHI_PACKAGE bool __fastcall TryStrToTime(const System::UnicodeString S, /* out */ System::TDateTime &Value)/* overload */;

Properties

Type Visibility Source Unit Parent
function public
System.SysUtils.pas
System.SysUtils.hpp
System.SysUtils System.SysUtils

Description

Converts a string to a TDateTime value with a default error.

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

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 A.M. or P.M. indicator. The numbers represent hour, minute, and (optionally) second, in that order. If the time is followed by A.M. or P.M., it is assumed to be in 12-hour clock format. If no A.M. or P.M. indicator is included, the time is assumed to be in 24-hour clock format.

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

See Also