xp_sprintf (Transact-SQL)
Formats and stores a series of characters and values in the string output parameter. Each format argument is replaced with the corresponding argument.
.gif "Topic link icon")
Transact-SQL Syntax Conventions
Syntax
xp_sprintf { string OUTPUT , format }
[ , argument [ ,...n ] ]
Arguments
- string
Is a varchar variable that receives the output.
- OUTPUT
When specified, puts the value of the variable in the output parameter.
- format
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.
- argument
Is a character string that represents the value of the corresponding format argument.
- n
Is a placeholder that indicates that a maximum of 50 arguments can be specified.
Return Code Values
0 (success) or 1 (failure)
Result Sets
xp_sprintf returns the following message:
The command(s) completed successfully.
Permissions
Requires membership in the public role.
See Also
Reference
System Stored Procedures (Transact-SQL)
General Extended Stored Procedures (Transact-SQL)
xp_sscanf (Transact-SQL)