sprintf詳解
sprintf() 格式化輸出函式(圖形)
功能: 函式sprintf()用來作格式化的輸出。
用法: 此函式呼叫方式為int sprintf(char *string,char *format,arg_list);
說明: 函式sprintf()的用法和printf()函式一樣,只是sprintf()函式給出第一個引數string(一般為字元陣列),然後再呼叫outtextxy()函式將串裡的字元顯示在螢幕上。arg_list為引數表,可有不定個數。通常在繪圖方式下輸出數字時可呼叫sprintf()函式將所要輸出的格式送到第一個引數,然後顯示輸出。
函式名: sprintf
功 能: 送格式化輸出到字串中
用 法: int sprintf(char *string, char *farmat [,argument,...]);
程式例:
#include <stdio.h>
#include <math.h>
int main(void)
{
char buffer[80];
sprintf(buffer, "An approximation of Pi is %f/n", M_PI);
puts(buffer);
return 0;
}
sprintf的作用是將一個格式化的字串輸出到一個目的字串中,而printf是將一個格式化的字串輸出到螢幕。sprintf的第一個引數應該是目的字串,如果不指定這個引數,執行過程中出現 "該程式產生非法操作,即將被關閉...."的提示。
因為C語言在進行字串操作時不檢查字串的空間是否夠大,所以可能會出現陣列越界而導致程式崩潰的問題。即使碰巧,程式沒有出錯,也不要這麼用,因為早晚會出錯。所以一定要在呼叫sprintf之前分配足夠大的空間給buf。
選自《CSDN 社群電子雜誌——C/C++雜誌》
http://emag.csdn.net2005 年1 月 總第1 期 - 93 -
本文作者:steedhorse(晨星)
printf 可能是許多程式設計師在開始學習C 語言時接觸到的第二個函式(我猜第一個是main),說
起來,自然是老朋友了,可是,你對這個老朋友瞭解多嗎?你對它的那個孿生兄弟sprintf 瞭解多
嗎?在將各種型別的資料構造成字串時,sprintf 的強大功能很少會讓你失望。
由於sprintf 跟printf 在用法上幾乎一樣,只是列印的目的地不同而已,前者列印到字串中,
後者則直接在命令列上輸出。這也導致sprintf 比printf 有用得多。所以本文著重介紹sprintf,有時
也穿插著用用pritnf。
sprintf 是個變參函式,定義如下:
int sprintf( char *buffer, const char *format [, argument] ... );
除了前兩個引數型別固定外,後面可以接任意多個引數。而它的精華,顯然就在第二個引數:
格式化字串上。
printf 和sprintf 都使用格式化字串來指定串的格式,在格式串內部使用一些以“%”開頭的
格式說明符(format specifications)來佔據一個位置,在後邊的變參列表中提供相應的變數,最終
函式就會用相應位置的變數來替代那個說明符,產生一個呼叫者想要的字串。
格式化數字字串
sprintf 最常見的應用之一莫過於把整數列印到字串中,所以,spritnf 在大多數場合可以替代
itoa。如:
//把整數[url=javascript:;]123
sprintf(s, "%d", 123); //產生"123"
可以指定寬度,不足的左邊補空格:
sprintf(s, "%8d%8d", 123, 4567); //產生:" 123 4567"
當然也可以左對齊:
sprintf(s, "%-8d%8d", 123, 4567); //產生:"123 4567"
也可以按照16 進位制列印:
sprintf(s, "%8x", 4567); //小寫16 進位制,寬度佔8 個位置,右對齊
sprintf(s, "%-8X", 4568); //大寫16 進位制,寬度佔8 個位置,左對齊
這樣,一個整數的16 進位制字串就很容易得到,但我們在列印16 進位制內容時,通常想要一
種左邊補0 的等寬格式,那該怎麼做呢?很簡單,在表示寬度的數字前面加個0 就可以了。
sprintf(s, "%08X", 4567); //產生:"000011D7"
上面以”%d”進行的10 進位制列印同樣也可以使用這種左邊補0 的方式。
這裡要注意一個符號擴充套件的問題:比如,假如我們想列印短整數(short)-1 的記憶體16 進製表
示形式,在Win32 平臺上,一個short 型佔2 個位元組,所以我們自然希望用4 個16 進位制數字來打
印它:
short si = -1;
sprintf(s, "%04X", si);
產生“FFFFFFFF”,怎麼回事?因為spritnf 是個變參函式,除了前面兩個引數之外,後面的
引數都不是型別安全的,函式更沒有辦法僅僅通過一個“%X”就能得知當初函式呼叫前引數壓棧
時被壓進來的到底是個4 位元組的整數還是個2 位元組的短整數,所以採取了統一4 位元組的處理方式,
導致引數壓棧時做了符號擴充套件,擴充套件成了32 位的整數-1,列印時4 個位置不夠了,就把32 位整數
-1 的8 位16 進位制都打印出來了。如果你想看si 的本來面目,那麼就應該讓編譯器做0 擴充套件而不是
符號擴充套件(擴充套件時二進位制左邊補0 而不是補符號位):
sprintf(s, "%04X", (unsigned short)si);
就可以了。或者:
unsigned short si = -1;
sprintf(s, "%04X", si);
sprintf 和printf 還可以按8 進位制列印整數字符串,使用”%o”。注意8 進位制和16 進位制都不會打
印出負數,都是無符號的,實際上也就是變數的內部編碼的直接的16 進位制或8 進製表示。
控制浮點數列印格式
浮點數的列印和格式控制是sprintf 的又一大常用功能,浮點數使用格式符”%f”控制,預設保
留小數點後6 位數字,比如:
sprintf(s, "%f", 3.1415926); //產生"3.141593"
但有時我們希望自己控制列印的寬度和小數位數,這時就應該使用:”%m.nf”格式,其中m 表
示列印的寬度,n 表示小數點後的位數。比如:
sprintf(s, "%10.3f", 3.1415626); //產生:" 3.142"
sprintf(s, "%-10.3f", 3.1415626); //產生:"3.142 "
sprintf(s, "%.3f", 3.1415626); //不指定總寬度,產生:"3.142"
注意一個問題,你猜
int i = 100;
sprintf(s, "%.2f", i);
會打出什麼東東來?“100.00”?對嗎?自己試試就知道了,同時也試試下面這個:
sprintf(s, "%.2f", (double)i);
第一個打出來的肯定不是正確結果,原因跟前面提到的一樣,引數壓棧時呼叫者並不知道跟i
相對應的格式控制符是個”%f”。而函式執行時函式本身則並不知道當年被壓入棧裡的是個整數,
於是可憐的儲存整數i 的那4 個位元組就被不由分說地強行作為浮點數格式來解釋了,整個亂套了。
不過,如果有人有興趣使用手工編碼一個浮點數,那麼倒可以使用這種方法來檢驗一下你手
工編排的結果是否正確。?
字元/Ascii 碼對照
我們知道,在C/C++語言中,char 也是一種普通的scalable 型別,除了字長之外,它與short,
int,long 這些型別沒有本質區別,只不過被大家習慣用來表示字元和字串而已。(或許當年該把
這個型別叫做“byte”,然後現在就可以根據實際情況,使用byte 或short 來把char 通過typedef 定
義出來,這樣更合適些)
於是,使用”%d”或者”%x”列印一個字元,便能得出它的10 進位制或16 進位制的ASCII 碼;反過
來,使用”%c”列印一個整數,便可以看到它所對應的ASCII 字元。以下程式段把所有可見字元的
ASCII 碼對照表列印到螢幕上(這裡採用printf,注意”#”與”%X”合用時自動為16 進位制數增加”0X”
字首):
for(int i = 32; i < 127; i++) {
printf("[ %c ]: %3d 0x%#04X/n", i, i, i);
}
連線字串
sprintf 的格式控制串中既然可以插入各種東西,並最終把它們“連成一串”,自然也就能夠連
接字串,從而在許多場合可以替代strcat,但sprintf 能夠一次連線多個字串(自然也可以同時
在它們中間插入別的內容,總之非常靈活)。比如:
char* who = "I";
char* whom = "CSDN";
sprintf(s, "%s love %s.", who, whom); //產生:"I love CSDN. "
strcat 只能連線字串(一段以’/0’結尾的字元陣列或叫做字元緩衝,null-terminated-string),
但有時我們有兩段字元緩衝區,他們並不是以’/0’結尾。比如許多從第三方庫函式中返回的字元數
組,從硬體或者網路傳輸中讀進來的字元流,它們未必每一段字元序列後面都有個相應的’/0’來結
尾。如果直接連線,不管是sprintf 還是strcat 肯定會導致非法記憶體操作,而strncat 也至少要求第
一個引數是個null-terminated-string,那該怎麼辦呢?我們自然會想起前面介紹列印整數和浮點數
時可以指定寬度,字串也一樣的。比如:
char a1[] = {'A', 'B', 'C', 'D', 'E', 'F', 'G'};
char a2[] = {'H', 'I', 'J', 'K', 'L', 'M', 'N'};
如果:
sprintf(s, "%s%s", a1, a2); //Don't do that!
十有八九要出問題了。是否可以改成:
sprintf(s, "%7s%7s", a1, a2);
也沒好到哪兒去,正確的應該是:
sprintf(s, "%.7s%.7s", a1, a2);//產生:"ABCDEFGHIJKLMN"
這可以類比列印浮點數的”%m.nf”,在”%m.ns”中,m 表示佔用寬度(字串長度不足時補空
格,超出了則按照實際寬度列印),n 才表示從相應的字串中最多取用的字元數。通常在列印字
符串時m 沒什麼大用,還是點號後面的n 用的多。自然,也可以前後都只取部分字元:
sprintf(s, "%.6s%.5s", a1, a2);//產生:"ABCDEFHIJKL"
在許多時候,我們或許還希望這些格式控制符中用以指定長度資訊的數字是動態的,而不是
靜態指定的,因為許多時候,程式要到執行時才會清楚到底需要取字元陣列中的幾個字元,這種
動態的寬度/精度設定功能在sprintf 的實現中也被考慮到了,sprintf 採用”*”來佔用一個本來需要一
個指定寬度或精度的常數數字的位置,同樣,而實際的寬度或精度就可以和其它被列印的變數一
樣被提供出來,於是,上面的例子可以變成:
sprintf(s, "%.*s%.*s", 7, a1, 7, a2);
或者:
sprintf(s, "%.*s%.*s", sizeof(a1), a1, sizeof(a2), a2);
實際上,前面介紹的列印字元、整數、浮點數等都可以動態指定那些常量值,比如:
sprintf(s, "%-*d", 4, 'A'); //產生"65 "
sprintf(s, "%#0*X", 8, 128); //產生"0X000080","#"產生0X
sprintf(s, "%*.*f", 10, 2, 3.1415926); //產生" 3.14"
列印地址資訊
有時除錯程式時,我們可能想檢視某些變數或者成員的地址,由於地址或者指標也不過是個32 位的數,你完全可以使用列印無符號整數的”%u”把他們打印出來:
sprintf(s, "%u", &i);
不過通常人們還是喜歡使用16 進位制而不是10 進位制來顯示一個地址:
sprintf(s, "%08X", &i);
然而,這些都是間接的方法,對於地址列印,sprintf 提供了專門的”%p”:
sprintf(s, "%p", &i);
我覺得它實際上就相當於:
sprintf(s, "%0*x", 2 * sizeof(void *), &i);
利用sprintf 的返回值
較少有人注意printf/sprintf 函式的返回值,但有時它卻是有用的,spritnf 返回了本次函式呼叫
最終列印到字元緩衝區中的字元數目。也就是說每當一次sprinf 呼叫結束以後,你無須再呼叫一次
strlen 便已經知道了結果字串的長度。如:
int len = sprintf(s, "%d", i);
對於正整數來說,len 便等於整數i 的10 進位制位數。
下面的是個完整的例子,產生10 個[0, 100)之間的隨機數,並將他們列印到一個字元陣列s 中,
以逗號分隔開。
#include <stdio.h>
#include <time.h>
#include <stdlib.h>
int main() {
srand(time(0));
char s[64];
int offset = 0;
for(int i = 0; i < 10; i++) {
offset += sprintf(s + offset, "%d,", rand() % 100);
}
s[offset - 1] = '/n';//將最後一個逗號換成換行符。
printf(s);
return 0;
}
設想當你從資料庫中取出一條記錄,然後希望把他們的各個欄位按照某種規則連線成一個字
符串時,就可以使用這種方法,從理論上講,他應該比不斷的strcat 效率高,因為strcat 每次呼叫
都需要先找到最後的那個’/0’的位置,而在上面給出的例子中,我們每次都利用sprintf 返回值把這
個位置直接記下來了。
使用sprintf 的常見問題
sprintf 是個變參函式,使用時經常出問題,而且只要出問題通常就是能導致程式崩潰的記憶體訪
問錯誤,但好在由sprintf 誤用導致的問題雖然嚴重,卻很容易找出,無非就是那麼幾種情況,通
常用眼睛再把出錯的程式碼多看幾眼就看出來了。
?? 緩衝區溢位
第一個引數的長度太短了,沒的說,給個大點的地方吧。當然也可能是後面的引數的問
題,建議變參對應一定要細心,而列印字串時,儘量使用”%.ns”的形式指定最大字元數。
?? 忘記了第一個引數
低階得不能再低階問題,用printf 用得太慣了。//偶就常犯。:。(
?? 變參對應出問題
通常是忘記了提供對應某個格式符的變參,導致以後的引數統統錯位,檢查檢查吧。尤
其是對應”*”的那些引數,都提供了嗎?不要把一個整數對應一個”%s”,編譯器會覺得你
欺她太甚了(編譯器是obj 和exe 的媽媽,應該是個女的,:P)。
strftime
sprnitf 還有個不錯的表妹:strftime,專門用於格式化時間字串的,用法跟她表哥很像,也
是一大堆格式控制符,只是畢竟小姑娘家心細,她還要呼叫者指定緩衝區的最大長度,可能是為
了在出現問題時可以推卸責任吧。這裡舉個例子:
time_t t = time(0);
//產生"YYYY-MM-DD hh:mm:ss"格式的字串。
char s[32];
strftime(s, sizeof(s), "%Y-%m-%d %H:%M:%S", localtime(&t));
sprintf 在MFC 中也能找到他的知音:CString::Format,strftime 在MFC 中自然也有她的同道:
CTime::Format,這一對由於從面向物件哪裡得到了贊助,用以寫出的程式碼更覺優雅。
後記
本文介紹的所有這些功能,在MSDN 中都可以很容易地查到,筆者只是根據自己的使用經驗,
結合一些例子,把一些常用的,有用的,而可能為許多初學者所不知的用法介紹了一點,希望大
家不要笑話,也希望大家批評指正。
有人認為這種帶變參的函式會引起各種問題,因而不提倡使用。但筆者本人每每還是抵擋不
了它們強大功能的誘惑,在實際工作中一直在使用。實際上,C#.NET 從開始就支援變參,剛釋出
不久的Java5.0 也支援變參了。