快捷導(dǎo)航

c語(yǔ)言snprintf函數(shù)的用法詳解

更新時(shí)間：2023年09月22日 09:41:15 作者：為搬磚記錄

這篇文章主要給大家介紹了關(guān)于c語(yǔ)言snprintf函數(shù)用法的相關(guān)資料,snprintf()函數(shù)用于將格式化的數(shù)據(jù)寫入字符串,文中通過代碼介紹的非常詳細(xì),需要的朋友可以參考下

語(yǔ)法：

int snprintf ( char * s, size_t n, const char * format, … );

參數(shù)：

s：指向要存儲(chǔ)字符串（由format參數(shù)格式化）的字符數(shù)組。
n：指定存儲(chǔ)字符串的最大字符數(shù)（不包括NULL結(jié)尾）。
format：是格式字符串，用于格式化輸出字符串。

返回值：

該函數(shù)返回實(shí)際寫入的字符數(shù)（不包括NULL結(jié)尾）。

snprintf()函數(shù)的最大特點(diǎn)是它可以防止由于格式化字符串太長(zhǎng)而導(dǎo)致的緩沖區(qū)溢出，它可以自動(dòng)截?cái)嘧址?，以確保不會(huì)超出緩沖區(qū)限制。

實(shí)例：

例如，下面的示例使用snprintf()函數(shù)將字符串“Hello world”存儲(chǔ)到一個(gè)大小為10個(gè)字符的字符數(shù)組中：

#include <stdio.h>
int main( )
{
   char str[10];
   snprintf(str, 10, "Hello world");
   printf("%s\n", str);
   return 0;
}

輸出：

Hello wor

這里面包含一個(gè)’\0’

特別注意

1. 無(wú)論何時(shí)一定會(huì)在字符串末尾添加'\0' 字符串結(jié)束符。

當(dāng)字符串長(zhǎng)度小于size時(shí)，會(huì)直接在字符串的末尾添加'\0';
當(dāng)字符串長(zhǎng)度等于size時(shí)，會(huì)取前size-1個(gè)字符，并在末尾添加‘\0’(即：加上'\0'后，一共size個(gè)字符);
當(dāng)字符串長(zhǎng)度大于size時(shí)，只取前size-1個(gè)字符，并在末尾添加'\0'(即：加上'\0'一共size個(gè)字符);

綜上：snprintf不僅一定會(huì)自動(dòng)在字符串末尾添加'\0'，而且一定會(huì)尊重指定長(zhǎng)度size的大小，不會(huì)超過該長(zhǎng)度(算上自動(dòng)在末尾增加的'\0')。所以從這一點(diǎn)來(lái)講，使用snprintf是相對(duì)比較安全的，不用擔(dān)心會(huì)出現(xiàn)overflow的情況。

NOTE：這一點(diǎn)上，snprintf與strncpy是有區(qū)別的。strncpy雖然也會(huì)指定目的內(nèi)存的大小，但是當(dāng)源字符串長(zhǎng)度大于指定的內(nèi)存大小時(shí)，strncpy雖然在達(dá)到指定大小后會(huì)停止copy，但是并不會(huì)在末尾自動(dòng)添加'\0'。這樣，在訪問字符串時(shí)，有可能出現(xiàn)overflow的情況，因?yàn)槟┪矝]有字符串結(jié)束符'\0'。

思考：

（1）當(dāng)目的內(nèi)存實(shí)際長(zhǎng)度為N1，但是在使用snprintf時(shí)指定的實(shí)際size（第二個(gè)參數(shù)）為N2, 且N2<N1，可能會(huì)出現(xiàn)什么情況？

（2）如果N2>N1，又可能出現(xiàn)什么情況？

2. 特別小心返回值。

當(dāng)出現(xiàn)錯(cuò)誤時(shí)，會(huì)返回負(fù)值；
當(dāng)字符串長(zhǎng)度小于size時(shí)，返回打印到目的內(nèi)存的實(shí)際字符串長(zhǎng)度（不包括'\0'）;
當(dāng)字符串長(zhǎng)度大于等于size時(shí)，盡管字符串會(huì)被截?cái)啵ㄖ挥衧ize-1個(gè)字符串被打印到目的內(nèi)存），但是返回值卻會(huì)返回源字符串的實(shí)際長(zhǎng)度（即假設(shè)目的內(nèi)存無(wú)限大，總是能寫下源字符串）。

綜上：snprintf的返回值可能大于或等于指定的size，這時(shí)候說(shuō)明目的內(nèi)存不夠大，源字符串被截?cái)?，需要小心處理，這是否是期望發(fā)生的情形。

NOTE：有一些寫法會(huì)利用snprintf的這個(gè)特點(diǎn)來(lái)確定合適的目的內(nèi)存大小，例如：

const char *fmt = "sqrt(2) = %f";
char * buf;
int sz = snprintf(NULL, 0, fmt, sqrt(2));
buf = (char *)malloc(sz+1);     // +1 for append '\0'
snprintf(buf, sz+1, fmt, sqrt(2));