System.SysUtils.TryStrToCurr

From Appmethod Libraries
Jump to: navigation, search

Object Pascal

function TryStrToCurr(const S: string; out Value: Currency): Boolean;
function TryStrToCurr(const S: string; out Value: Currency; const AFormatSettings: TFormatSettings): Boolean;

C++

extern DELPHI_PACKAGE bool __fastcall TryStrToCurr(const System::UnicodeString S, /* out */ System::Currency &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 Currency value, with a Boolean success code.

Call TryStrToCurr to convert a string that represents a floating-point value to the corresponding Currency value. The source string, S, must consist of an optional sign (+ or -), a string of digits with an optional decimal point, and an optional 'E' or 'e' followed by a signed integer. Leading and trailing blanks are ignored.

The DecimalSeparator global variable or its TFormatSettings equivalent defines the character that is used as a decimal point. Thousand separators and currency symbols are not allowed in the string. If the string does not contain a valid value, TryStrToCurr returns Default.

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

See Also