C 库函数
int snprintf(char *str, size_t size, const char *format, ...)
设将可变参数
(...)
按照
format
格式化成字符串,并将字符串复制到
str
中,
size
为要写入的字符的最大数目,超过
size
会被截断,最多写入 size-1 个字符。
与
sprintf()
函数不同的是,snprintf() 函数提供了一个参数 size,可以防止缓冲区溢出。如果格式化后的字符串长度超过了 size-1,则 snprintf() 只会写入 size-1 个字符,并在字符串的末尾添加一个空字符(\0)以表示字符串的结束。
下面是 snprintf() 函数的声明。
int snprintf ( char * str, size_t size, const char * format, ... );
str
-- 目标字符串,用于存储格式化后的字符串的字符数组的指针。
size
-- 字符数组的大小。
format
-- 格式化字符串。
...
-- 可变参数,可变数量的参数根据 format 中的格式化指令进行格式化。
snprintf() 函数的返回值是输出到 str 缓冲区中的字符数,不包括字符串结尾的空字符 \0。如果 snprintf() 输出的字符数超过了 size 参数指定的缓冲区大小,则输出的结果会被截断,只有 size - 1 个字符被写入缓冲区,最后一个字符为字符串结尾的空字符 \0。
需要注意的是,snprintf() 函数返回的字符数并不包括字符串结尾的空字符 \0,因此如果需要将输出结果作为一个字符串使用,则需要在缓冲区的末尾添加一个空字符 \0。
下面的实例演示了 snprintf() 函数的用法。
#include <stdio.h>
int
main
(
)
char
buffer
[
50
]
;
char
*
s
=
"runoobcom"
;
// 读取字符串并存储在 buffer 中
int
j
=
snprintf
(
buffer,
6
,
"%s
\n
"
, s
)
;
// 输出 buffer及字符数
printf
(
"string:
\n
%s
\n
character count = %d
\n
"
, buffer, j
)
;
return
0
;
输出结果为:
string:
runoo
character count = 10
注意事项:
-
snprintf()
函数在格式化字符串时,可以避免缓冲区溢出。
-
如果格式化后的字符串的长度超过了
size-1
,则
snprintf()
函数只会写入
size-1
个字符,并在字符串的末尾添加一个空字符(
\0
)以表示字符串的结束。
-
如果
str
参数为
NULL
,则
snprintf()
函数不会写入任何字符,但仍然返回计划写入的字符数。
-
如果
size
参数为
0
,则
snprintf()
函数不会写入任何字符,但仍然返回计划写入的字符数。
-
snprintf()
函数不支持浮点数的格式化,如果需要格式化浮点数,应使用
sprintf()
函数。
-
在使用
snprintf()
函数时,需要注意格式化字符串的安全性,尤其是在使用用户提供的字符串时。如果格式化字符串中包含用户输入的字符串,并且该字符串中包含格式化指令,可能会导致安全问题。可以使用一些安全的字符串格式化库,例如
snprintf_s()
,
_snprintf()
,
_sntprintf()
等。
C 标准库 - <stdio.h>