System.UnicodeString.Format

From RAD Studio API Documentation
Jump to: navigation, search

C++

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

Properties

Type Visibility Source Unit Parent
function public ustring.h System UnicodeString

Description

Formats a string assembled from UnicodeString, format, and array arguments.

Use Format to obtain a UnicodeString object whose value is the result of applying an array of arguments (args) to a given standard C++ format specifier string (format). The last parameter (size) is the 1-based 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 UnicodeString, even if the method is called with an existing UnicodeString 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