xp_sprintf (Transact-SQL)

Applies to: SQL Server

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

Transact-SQL syntax conventions


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


'string' OUTPUT

A varchar variable that receives the output.

When OUTPUT is specified, this option puts the value of the variable in the output parameter.


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


A character string that represents the value of the corresponding format argument.


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

Return code values

0 (success) or 1 (failure).

Result set

xp_sprintf returns the following message:

The command(s) completed successfully.


Requires membership in the public role.

See also