31.1 FORMAT Function

Returns a formatted string, with substitutions applied.

Returns p_message after replacing each <n>th occurrence of %s with p<n> and each occurrence of %<n> with p<n>. If p_max_length is not null, substr(p<n>,1,p_arg_max_length) is used instead of p<n>.

Syntax

format (
     p_message    in varchar2,
     p0           in varchar2     default null,
     p1           in varchar2     default null,
     p2           in varchar2     default null,
     p3           in varchar2     default null,
     p4           in varchar2     default null,
     p5           in varchar2     default null,
     p6           in varchar2     default null,
     p7           in varchar2     default null,
     p8           in varchar2     default null,
     p9           in varchar2     default null,
     p10          in varchar2     default null,
     p11          in varchar2     default null,
     p12          in varchar2     default null,
     p13          in varchar2     default null,
     p14          in varchar2     default null,
     p15          in varchar2     default null,
     p16          in varchar2     default null,
     p17          in varchar2     default null,
     p18          in varchar2     default null,
     p19          in varchar2     default null,
     p_max_length in pls_integer  default 1000 )
     return varchar2

Parameters

Table 31-1 FORMAT Function Parameters

Parameters	Description
`p_message`	Message string with substitution placeholders.
`p0-p19`	Substitution parameters.
`p_max_length`	If not null (default is 1000), cap each `p<n>` at `p_max_length` characters.

Example

apex_string.format('%s+%s=%s', 1, 2, 'three')
-> 1+2=three

apex_string.format('%1+%2=%0', 'three', 1, 2)
-> 1+2=three

Parent topic: APEX_STRING