WideString::Format Method

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

Pascal

function Format(const format: WideString&; const args: TVarRec *; size: Integer): WideString; static;

C++

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

Description

Use System::WideString::Format to obtain an System::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 System::WideString::Format is a static method. The returned value is a newly allocated System::WideString, even if the method is called from an existing System::WideString instance.

For information on how System::WideString::Format assembles a final string from its format string and arguments, see System::WideString::Format Strings.