编程技能：格式化打印04，sprintf

专栏导航

本节文章分别属于《Win32 学习笔记》和《MFC 学习笔记》两个专栏，故划分为两个专栏导航。读者可以自行选择前往哪个专栏。

（一）WIn32 专栏导航

上一篇：编程技能：格式化打印03，printf

回到目录

下一篇：无

（二）MFC 专栏导航

上一篇：编程技能：格式化打印03，printf

回到目录

下一篇：无

本节前言

在上一节，我们讲解了 printf 的实现代码。

本节，我们来讲解与之相近的 sprintf 的实现代码。

对于本节的讲解，是基于 vsprintf 的知识的。

如果你尚未学习过 vsprintf 的知识，请参考下述链接所示的文章。

编程技能：格式化打印02，vsprintf-CSDN博客

确保你理解了 vsprintf 的大致逻辑之后，接下来，我们来学习 printf 的实现代码。

在本节里面，我会用到三个术语。他们分别是【栈指针】，【格式字符串】和【参数列表】。这三个术语，均可以从 vsprintf 文章链接中找到。如果你不懂这些术语，请你先去上面的 vsprintf 文章链接中，学习好 vsprintf ，然后再进行本节的学习。

我们开始本节的讲解。

一.    sprintf 函数的实现代码

代码如下。

extern int sprintf(char * str, const char *fmt, ...)
{va_list args;int i;va_start(args, fmt);i = vsprintf(str, fmt, args);va_end(args);return i;
}

这段代码，改编自 Linux 0.12 内核。绝大部分的代码，都与 0.12 内核一样。但是呢，我也的确是作出了一点小小的改动。

二.    调用 sprintf 函数的三个案例

下面是案例1 的代码。

static char buf01[300];
void func01(void)
{int i, a, c;float b;a = 90;b = 3.14;c = 1024;i = sprintf(buf01, "a = %d，b = %f，c = %x", a, b, c);return;
}

以上为案例1 的代码。

下面是案例2 的代码。

static char buf02[300];
void func02(void)
{int i;i = sprintf(buf02, "小雪的兜里有 %d 块钱", 100);return;
}

以上为案例 2 的代码。

下面是案例3 的代码

static char buf03[300];
void func03(void)
{int i;i = sprintf(buf03, "I have a pen");return;
}

以上为案例3 的代码。

这几个代码，我们在下面的讲解中，随时会引用。大家需要浏览一下这几个代码。一会儿，你需要随时来查阅对照这几个案例代码。

三.    sprintf 的函数头部

sprintf 的函数头部如下。

extern int sprintf(char * str, const char *fmt, ...)

对于此函数的返回值，我们先不去讲。我们来看看它的各个参数。

（一）缓冲区

第一个参数，是字符指针 str 。这个字符指针，是由调用 sprintf 的函数提供的。

第二分节的案例1 代码里，包含有下述两行代码。

static char buf01[300];

i = sprintf(buf01, "a = %d，b = %f，c = %x", a, b, c);

在案例1 里面，我们声明了一个大的字符数组，里面包含 300 个元素。数组名为 buf01 。数组元素为 char 型，所以，数组名为字符指针。而在案例1 的调用 sprintf 函数的代码中，传入的第一个参数，为字符数组名 buf01 。

在案例2 和案例3 里面，也有类似的代码逻辑。也就是，申请了一个大的字符数组。同时，在调用 sprintf 函数的时候，给 sprintf 传入的第一个参数，是这个字符数组的数组名。

一般地，我们平时在申请数组的时候，不会让数组包含着这么多的元素个数。然而，在本节的第二分节的三个案例代码里面，我们的确是分别申请了一个大的字符数组。

申请这么大的数组干嘛？

一般来讲，当我们选择申请一个尺寸很大的数组的时候，我们是想要用它来临时地保存某些数据。这种临时地保存某些数据的，尺寸很大的数组，我们可以给它换一个名字，缓冲区。

在 Linux 0.12 内核里面，为了实现 printf 函数，它是申请了包含 1024 个 char 型元素的字符数组，作为缓冲区，来给 printf 函数使用。

关于缓冲区的概念，其实，大家在基础的 C 语言学习中，大家也听说过的。那就是键盘缓冲区。

在 Linux 0.12 内核里面，就包含有一个键盘缓冲区，它也是用包含着 1024 个元素的大数组，来作为键盘缓冲区的。

buf，常常用作【缓冲区】的含义，它是 buffer 的简写。

我们接着往下讲。

（二）格式字符串

在 sprintf 的函数头部里面，第二个参数，为【const char *fmt】。从这里可以看出，本参数用来接收一个字符串，并且，由于 const 关键字的存在，我们不可以通过字符指针 fmt 对这个接收的字符串进行任何改动，而只是可以使用其值。

在这里，我将 fmt 接收的字符串，称作格式字符串。

所谓的格式字符串，是说，它里面，可能会含有 %d，%c，%f，%s 等等的格式控制符。

在代码【printf("a = %d，b = %f，c = %x", a, b, c);】中，【"a = %d，b = %f，c = %x"】是格式字符串。类似地，在本文的的第二分节的案例1 代码里面，在代码【i = sprintf(buf01, "a = %d，b = %f，c = %x", a, b, c);】中， 【"a = %d，b = %f，c = %x"】也是格式字符串，由sprintf 的第二个形参 fmt 来接收。

在代码【printf("小雪的兜里有 %d 块钱", 100);】里面，【"小雪的兜里有 %d 块钱"】是格式字符串。类似地，在本文的的第二分节的案例2 代码里面，在代码【i = sprintf(buf02, "小雪的兜里有 %d 块钱", 100);】中， 【"小雪的兜里有 %d 块钱"】也是格式字符串，由sprintf 的第二个形参 fmt 来接收。

在代码【printf("I have a pen");】里面，【"I have a pen"】是格式字符串。类似地，在本文的的第二分节的案例3 代码里面，在代码【i = sprintf(buf03, "I have a pen");】中， 【"I have a pen"】也是格式字符串，由sprintf 的第二个形参 fmt 来接收。

格式字符串，里面可以包含有 %d 等等的格式控制符，也可以不包含。

到了这里，sprintf 的第二个形参我们就讲完了。我们接着讲。

（三）可变参数

在 sprintf 函数头部里面，在 fmt 形参的右边，是【...】，这个东西，不是省略号。你也可以在你自己的代码里面包含这样的东西。不过呢，使用的时候，是三个英文句点，不可以是中文的三个句点。在数量上，必须是三个，多一个不行，少一个也不行。

这个【...】，有一个专有名字，叫做可变参数。

可变参数，是说，它的数目是可变的，每一个参数的数据类型也是可变的，没有固定的范式。在数目方面，可变参数中，可以包含有一个参数，两个参数，或者多个参数，也可以不包含参数。

在代码【printf("a = %d，b = %f，c = %x", a, b, c);】中，【a, b, c】的部分，便是可变参数部分。类似地，在本文的的第二分节的案例1 代码里面，在代码【i = sprintf(buf01, "a = %d，b = %f，c = %x", a, b, c);】中，【a, b, c】的部分，也是可变参数部分。在此代码示例中，可变参数部分含有三个参数。

在代码【printf("小雪的兜里有 %d 块钱", 100);】中，【100】的部分，为可变参数部分。类似地，在本文的的第二分节的案例2 代码里面，在代码【i = sprintf(buf02, "小雪的兜里有 %d 块钱", 100);】中，【100】的部分，也是可变参数部分。在此代码示例中，可变参数部分含有一个参数。

在代码【printf("I have a pen");】里面，可变参数部分无参数。类似地，在本文的的第二分节的案例3 代码里面，在代码【i = sprintf(buf03, "I have a pen");】中，可变参数部分也是没有参数的。

在大家平时写代码的时候，应该不太会去使用可变参数的。不过，这次，我们要来学习 printf，vsprintf，sprintf 等等的打印函数，那就需要来接触可变参数了。

我尽力去讲，希望大家能够学好可变参数。

到了这里，sprintf 的函数头部，我们就先进行到这里。返回值，后面会有讲解。

四.    va_list

我们来看下图的红色框线部分的代码。

图1

图1 中的红色框线部分，是变量声明。【int i;】，这个简单，声明了一个整型变量 i 。问题在于【va_list args;】这一部分，需要去讲解一下的，是 va_list 。va_list，是【char *】的意思。

请看下面的参考代码。

typedef char *va_list;

va_list，是【char *】的别名。这样一来，由 va_list 声明的 args 变量，便是一个【char *】类型的变量。

在这里，我来讲一讲 va_list 的含义。va_list 中的 va，是【variable argument】的意思，翻译过来，就是可变参数的意思。list，是列表的含义。所以呢，va_list，整个的意思就是【可变参数列表】。用【可变参数列表】类型 va_list 声明的变量为 args，它是 arguments 的简写，就是【各个参数】的意思。

我们接着往下看。

五.    va_start

我们来看下图中的红色框线部分的代码。

图2

va_start，直接翻译，就是【可变参数开始】的意思。其实，它是用来对可变参数变量 args 进行初始化的宏函数。

va_start，从它的使用方法上看，似乎是一个函数。实际上，它是一个宏。对于这种，实际上为宏，而外形为函数的东西，我将其称作宏函数。别的地方咋叫我记不清了。反正我就管它叫宏函数。

va_start，它的宏代码，具体是什么，在这里，我不展开。原因在于，想要彻底理解其宏代码，你需要具备汇编语言基础。在设计本专栏教程的时候，我的一个基本的假定，就是，各位读者并不具备汇编语言基础。我希望在各位并不具备汇编语言基础的情况下，也能够看懂本专栏教程。

由于假定各位不懂汇编语言，所以，va_start 的宏代码，我就不去细讲了。但是呢，它的功能，我还得来说一说的。

va_start(args, fmt) 的意思是说，将可变参数变量 args，赋值为 fmt 右边的可变参数列表中第一个变量的栈指针。

栈指针又是什么？

我们在讲解 vsprintf 的时候，有去详细讲它。

在讲解 vsprintf 的时候，我们所给出的栈指针的大致含义如下。

A 函数调用 B 函数的时候，会将 B 函数所需要的参数，也就是传递给 B 函数的实参，压入栈中。完成了参数入栈的工作以后，CPU 才会前往执行 B 函数的代码。那么，A 函数所传递的某一个参数在栈中的位置，就是这个实参的栈指针。

在这里，如果你需要进一步理解栈指针的含义，那么，你可以参考 vsprintf 的讲解。讲解 vsprintf 的文章链接如下所示。

编程技能：格式化打印02，vsprintf-CSDN博客

不过，说实话，我在讲解 vsprintf 的时候，对栈指针的讲解，做不到让你彻底地理解栈指针的含义。因为，想要彻底地理解栈指针的概念，你需要具备汇编语言基础。此处，你只要能够模糊地，大致地理解栈指针的概念就可以了。

我们接着往下讲。

为了辅助大家理解 va_start 的含义，我们来举几个例子。

在案例1 中的代码【i = sprintf(buf01, "a = %d，b = %f，c = %x", a, b, c);】中，在调用了 sprintf 函数以后，在 sprintf 函数内部，代码【va_start(args, fmt);】的执行，会将 args 赋值为格式字符串【"a = %d，b = %f，c = %x"】右边的可变参数列表中的第一个参数，a 的栈指针。

在案例2 中的代码【i = sprintf(buf02, "小雪的兜里有 %d 块钱", 100);】里面，在调用了 sprintf 函数以后，在 sprintf 函数内部，代码【va_start(args, fmt);】的执行，会将 args 赋值为格式字符串【"小雪的兜里有 %d 块钱"】右边的可变参数列表中的第一个参数，【100】的栈指针。

在案例3 中的代码【i = sprintf(buf03, "I have a pen");】里面，可变参数部分无参数。在这种情况下，代码【va_start(args, fmt);】的执行也会令 args 指向一个东西，不过，在可变参数部分无参数的情况下，args 究竟是指向啥，我们就不必关心了。我们暂时只关心可变参数列表中至少含有一个参数的情形，并且将可变参数列表中包含至少一个参数的情形视为典型。

再次重复一下，va_start(args, fmt) 的意思是说，将可变参数变量 args，赋值为 fmt 所指向的格式字符串右边的可变参数列表中的第一个变量的栈指针。

正是在 va_start 宏函数的作用之下，可变参数列表中的第一个参数的栈指针，被提取出来了。

不知道，你理解得是否费劲儿。反正，此刻，我是觉得，讲得挺费劲儿的。

接着来吧。

六.    调用 vsprintf

我们接着看下图的红色框线所示的代码。

图3

在图3 的红色框线部分，我们调用了 vsprintf 函数，传给它的三个参数，分别是由上一级的调用函数传过来的字符缓冲区指针【str】，格式字符串的指针【fmt】，还有可变参数列表中第一个参数的栈指针【args】。

vsprintf 函数的功能，是根据 fmt 与 args，对 fmt 所指向的格式字符串进行格式化转换，转换结果放在字符缓冲区指针 str 所指向的字符数组里面。格式化转换的工作完成以后，str 中的字符串的不含 NUL 结束符的有效字符长度，会作为返回值，予以返回。在图3 里面，这个返回值由 int 型变量 i 来接收了。

vsprintf 是如何进行格式化转换的，请大家参考 vsprintf 文章链接，链接如下。

编程技能：格式化打印02，vsprintf-CSDN博客

不过呢，在这里，虽说我不想细讲 vsprintf 的执行过程。不过呢，我还是想要举几个例子。

例如，在执行本文第二分节的案例1 中的代码【i = sprintf(buf01, "a = %d，b = %f，c = %x", a, b, c);】以后，sprintf 会在内部调用 vsprintf 。 vsprintf 会根据格式字符串【"a = %d，b = %f，c = %x"】与可变参数列表中第一个参数的栈指针，对格式字符串进行格式化转换。对于案例1 而言，格式化转换的结果为【"a = 90，b = 3.14，c = 400"】，这个转换结果会被存放在 str 缓冲区里面，或者说是存放在案例1 中的 buf01 缓冲区里面。十进制 1024 的十六进制值为 0x400 。我在格式字符串里面，没有给十六进制值加上十六进制前缀，你可以自己添加啊。这里，我偷个懒。

再比如，在执行本文第二分节的案例2 中的代码【i = sprintf(buf02, "小雪的兜里有 %d 块钱", 100);】以后，sprintf 会在内部调用 vsprintf 。 vsprintf 会根据格式字符串【"小雪的兜里有 %d 块钱"】与可变参数列表中第一个参数的栈指针，对格式字符串进行格式化转换。格式化转换的结果为【"小雪的兜里有 100 块钱"】，这个转换结果会被存放在 str 缓冲区里面，或者说是存放在案例2 中的 buf02 缓冲区里面。

再比如，在执行本文第二分节的案例3 中的代码【i = sprintf(buf03, "I have a pen");】以后，sprintf 会在内部调用 vsprintf 。 vsprintf 会根据格式字符串【"I have a pen"】与可变参数列表中第一个参数的栈指针，对格式字符串进行格式化转换。在此例子代码中，由于格式字符串里面不含有格式控制符，可变参数列表里面也不含有参数，因此，vsprintf 的工作，是直接把字符串【"I have a pen"】放在 str 缓冲区中，或者说是存放在案例3 中的 buf03 缓冲区中，而并不需要专门的格式化转换工作。

我们接着往下看。

七.    va_end

我们来看下图的红色框线部分所示的代码。

图4

va_end，依然是一个宏函数。

va_end(args)，它的作用，是将 args 置空。由于 args 是 va_list 类型的，也就是【char *】类型，所以呢，【va_end(args);】的作用，相当于执行代码【args = NULL;】。就这么简单。在这里，我将 va_end 的宏代码给展示一下。

#define va_end(AP) (AP = NULL)

这个宏代码，应该是不难吧？

如果不理解的话，请查阅 C 语言基础知识教材。

在 va_start 宏函数里面，初始化了 args 变量。在调用 vsprintf 的时候，使用了 args 变量。最后呢，在 va_end 宏函数里面，清理了 args 变量。

我们接着往下看。

八.    打印输出与返回

请先看下图的红色框线所示的代码。

图5

图5 中的红色框线部分，是返回语句【return i】。

关于变量 i，在本文的第六节中，讲解 vsprintf 函数调用的时候，我谈到了，vsprintf 会将完成了格式化转换工作以后，保存在 str 缓冲区中的字符串的不含有 NUL 结束符的有效字符长度作为返回值，予以返回。这个返回值，被赋值给 int 型变量 i 了。

所以呢，此时，变量 i 里面所保存的，是 str 缓冲区中的字符串的不含有 NUL结束符的有效字符长度。

而在 sprintf 函数实现代码的末尾，这个有效字符长度，再一次作为返回值，予以返回了。

在我的学习经历中，这个返回值，还是有用的。至于究竟是如何来使用，我们在以后的 Windows 编程教程中，会见到的。

WIndows 编程，我打算分为 Win32 与 MFC 两块来讲。在 MFC 专栏里面，可能对 sprintf 用得不多。然而，在 Win32 专栏里面，我们用 sprintf 会多一些。当然了，我们不是直接用 sprintf ，而是用它的 WIndows 版本，wsprintf 函数。

九.    sprintf 函数总结

我们对 sprintf 的函数功能进行一个小小的总结。

我们还是先来看一下 sprintf 的函数头部。

extern int sprintf(char * str, const char *fmt, ...);

sprintf 函数的功能，根据 fmt 所指向的格式字符串与可变参数列表中第一个参数的栈指针，对格式字符串进行格式化转换工作。转换好的字符串，会被存放在 str 缓冲区里面。函数的返回值，为格式化转换工作完成以后，存放在 str 缓冲区中的字符串的不含有 NUL 结束符的有效字符长度。

对函数返回值部分，我特意用橄榄色的粗体字来标识了。我还是再来重复一下。简单地来讲，sprintf 函数的返回值，为有效字符长度。

到了这里，本节的讲课任务就都完成了。

结束语

相比上一节讲解 printf 的时候来讲，本节的写作，算是轻松了一些，因为大部分都是复制粘贴。然而，也还有许多东西是需要去修改的。

sprintf，我认为是比较重要的函数。希望大家能够学习好它。

其实，到了这里，主体任务，vsprintf，printf，sprintf，这三大格式化打印函数，我们就都讲完了。到了这里，格式化打印部分，可以说是完成了。

不过，我还想要补充一点东西。那就是，对于格式控制符，它还有一些个东西，我想要去补充补充。也许，这个补充是不必要的。不过，我还是想要补充一下。

下一节，将会是格式化打印板块的最后一节。同时，Windows 编程的预备知识部分，也将在下一节画上句号。

本节结束。

专栏导航

本节文章分别属于《Win32 学习笔记》和《MFC 学习笔记》两个专栏，故划分为两个专栏导航。读者可以自行选择前往哪个专栏。

（一）WIn32 专栏导航

上一篇：编程技能：格式化打印03，printf

回到目录

下一篇：无

（二）MFC 专栏导航

上一篇：编程技能：格式化打印03，printf

回到目录

下一篇：无