xp_sprintf (Transact-SQL)

SQL Server 2012

Formats and stores a series of characters and values in the string output parameter. Each format argument is replaced with the corresponding argument.

Topic link icon Transact-SQL Syntax Conventions

xp_sprintf { string OUTPUT , format }
     [ , argument [ ,...n ] ]


Is a varchar variable that receives the output.


When specified, puts the value of the variable in the output parameter.


Is a format character string with placeholders for argument values, similar to that supported by the C-language sprintf function. Currently, only the %s format argument is supported.


Is a character string that represents the value of the corresponding format argument.


Is a placeholder that indicates that a maximum of 50 arguments can be specified.

0 (success) or 1 (failure)

xp_sprintf returns the following message:

The command(s) completed successfully.

Requires membership in the public role.