System.SysUtils.WideFormat

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function WideFormat(const Format: WideString; const Args: array of const): WideString;
function WideFormat(const Format: WideString; const Args: array of const; const AFormatSettings: TFormatSettings): WideString;

C++

extern DELPHI_PACKAGE System::WideString __fastcall WideFormat(const System::WideString Format, System::TVarRec const *Args, const int Args_High)/* overload */;

Properties

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

Description

Returns a formatted Unicode string assembled from a format string and an array of arguments.

This function formats the series of arguments in the open array Args. Formatting is controlled by the format string Format; the results are returned in the function result as a Unicode string.

For information on the format strings, see Format strings.

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

See Also