Edit

Share via

xp_sprintf (Transact-SQL)

  • Article

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

Syntax

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

Arguments

Important

Arguments for extended stored procedures must be entered in the specific order as described in the Syntax section. If the parameters are entered out of order, an error message occurs.

'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.

'format'

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.

'argument'

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

n

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.

Permissions

Requires membership in the public role.

Related content