snprintf() 是 C语言的一个标准库函数,定义在<stdio.h>
头文件中。
snprintf() 函数的功能是格式化字符串,并将结果存储在指定的字符数组中。该函数的原型如下:
cpp
int snprintf(char *str, size_t size, const char *format[,argument...]);
参数
- str:指向一个字符数组,用于存储格式化后的字符串,该数组的大小至少为 size。
- size:指定写入 str 数组中字符的最大个数(包括最后的空字符 '\0')。
- format:包含格式说明符的字符串,它定义了后续参数的输出格式。
- [,argument...]:可变参数列表,与格式字符串中的格式说明符相匹配。
重点讲解一下 format 参数,它由格式说明和普通字符构成。其中,普通字符是按照原样输出的字符,如逗号、空格和换行符;格式说明定义 argument 的显示格式,它以"%"开头,后面跟格式字符,格式字符前面还可以有其他修饰符,表示输出数据的宽度、精度等。
参数 format 的格式如下:
%[flags][width][.precision][length]格式字符
格式说明的个数必须与参数 argument 的个数一致。
- 格式字符及说明如下表所示。
格式字符 | 说明 | 示例 |
---|---|---|
d 或 i | 带符号十进制整数 | 26、 285 |
o | 无符号八进制整数 | 316、 501 |
x | 无符号十六进制整数 | 8cf、32b7 |
X | 无符号十六进制整数(以大写形式输出) | 8CF、32B7 |
u | 无符号十进制整数 | 1234、 32727 |
f | 小数形式的单、双精度浮点数 | 102.6、2987.58 |
e 或 E | 指数形式的单、双精度浮点数 | 1.026e+2、1.026E+2 |
g 或 G | 以 %f 或 %e 的形式输出浮点数 | 102.6 |
c | 单个字符 | 'a'、A |
s | 字符串 | "hello" |
p | 输出一个指针 | 0012FF7C |
- flags 控制输出数据的对齐方式,flags 及说明如下表所示。
flags | 说明 |
---|---|
- | 在给定的域宽内靠左端输出 |
+ | 强制在正数前输出 + 号,在负数前输出 - 号 |
# | 使用 o、x 或 X 格式时,在数据前面分别增加前导符 0、0x 或 0X 输出 |
- width 控制数据输出的宽度,width 及说明如下表所示。
width | 说明 |
---|---|
m | 输出字段的宽度,如果数据的宽度小于 m,则左端补上空格;否则按照实际位数输出 |
- precision 表示单精度和双精度浮点数的小数点个数,precision 及说明如下表所示。
precisi on | 说明 |
---|---|
n | 对于浮点数,表示输出 n 位小数;对于字符串,表示输出字符串的个数 |
- length 表示整型数据是长整型还是短整型,length 及说明如下表所示。
length | 说明 |
---|---|
h | 用来输出短整型数据(只对 i、d、0、u、x 和 X 有效) |
l 或 L | 用来输出长整型数据和双精度型数据 |
返回值
如果参数 size 的值足够大,则函数返回写入到 str 数组中的字符个数(不包括结尾的空字符),它的值位于[0, size-1]
之间。
如果写入过程发生错误,则返回负数。
如果返回值≥size
,则表示存储 format 格式化字符串实际需要的数组大小(不包括结尾的空字符)。
【例一】以下的 C 语言代码示例演示了 snprintf() 函数的功能和用法。
cpp
#include <stdio.h>
int main() {
char buffer[50];
int value = 42;
float pi = 3.14159;
// 使用snprintf格式化字符串,并将结果存储在buffer中
int written = snprintf(buffer, sizeof(buffer), "Value: %d, Pi: %.2f", value, pi);
// 打印格式化后的字符串
if (written > 0 && written < sizeof(buffer)) {
printf("Formatted string: %s\n", buffer);
} else {
printf("Buffer size is not enough, needed: %d\n", written);
}
return 0;
}
输出结果为:
Formatted string: Value: 42, Pi: 3.14
示例中,snprintf() 用于将整数和浮点数格式化为字符串,并将结果存储在 buffer 中。我们还检查了返回值,确保格式化后的字符串成功存储到 buffer 数组中。
【例二】以下的 C 语言代码示例演示了 snprintf() 函数返回值大于 size 参数的情况。
cpp
#include <stdio.h>
int main() {
char buffer[10];
int value = 123456;
int written = snprintf(buffer, sizeof(buffer), "Value: %d", value);
printf("buffer:%s\n", buffer);
printf("Needed size: %d\n", written);
return 0;
}
输出结果为:
buffer:Value: 12
Needed size: 13
在这个例子中,格式化后的字符串 "Value: 123456" 的长度明显超过了 buffer 数组长度。在这种情况下,snprintf() 将只写入 size-1 个字符(Value: 12),并在最后添加空字符。同时,它还会返回一个表示完整格式化字符串所需大小的整数值(不包括结尾的空字符 '\0')。