System.WideString.Format

From RAD Studio API Documentation
Jump to: navigation, search

C++

static WideString Format(const WideString& format,
                  const TVarRec *args, int size);

Properties

Type Visibility Source Unit Parent
function public wstring.h System WideString

Description

Formats a string assembled from a WideString, format, and a series of array arguments, args.

Use Format to obtain a WideString whose value is the result of applying an array of arguments (args) to a given a format string (format). The last parameter (size) is the index of the last element in args (one less than the number of arguments).

Note that Format is a static method. The returned value is a newly allocated WideString, even if the method is called from an existing WideString instance.

For information on how Format assembles a final string from its format string and arguments, see "Format Strings" in System.SysUtils.Format.

See Also