System.AnsiStringBase.Format

From Appmethod Libraries
Jump to: navigation, search

C++

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

Properties

Type Visibility Source Unit Parent
function public dstring.h System AnsiStringBase

Description

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

Use Format to obtain an AnsiStringBase, whose value is the result of applying an array of arguments (args) to a given 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 AnsiStringBase, even if the method is called from an existing AnsiStringBase 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