c語言snprintf函數的用法詳解

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

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

語法：

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

參數：

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

返回值：

該函數返回實際寫入的字符數（不包括NULL結尾）。

snprintf()函數的最大特點是它可以防止由于格式化字符串太長而導致的緩沖區(qū)溢出，它可以自動截斷字符串，以確保不會超出緩沖區(qū)限制。

實例：

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

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

輸出：

Hello wor

這里面包含一個’\0’

特別注意

1. 無論何時一定會在字符串末尾添加'\0' 字符串結束符。

當字符串長度小于size時，會直接在字符串的末尾添加'\0';
當字符串長度等于size時，會取前size-1個字符，并在末尾添加‘\0’(即：加上'\0'后，一共size個字符);
當字符串長度大于size時，只取前size-1個字符，并在末尾添加'\0'(即：加上'\0'一共size個字符);

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

NOTE：這一點上，snprintf與strncpy是有區(qū)別的。strncpy雖然也會指定目的內存的大小，但是當源字符串長度大于指定的內存大小時，strncpy雖然在達到指定大小后會停止copy，但是并不會在末尾自動添加'\0'。這樣，在訪問字符串時，有可能出現(xiàn)overflow的情況，因為末尾沒有字符串結束符'\0'。

思考：

（1）當目的內存實際長度為N1，但是在使用snprintf時指定的實際size（第二個參數）為N2, 且N2<N1，可能會出現(xiàn)什么情況？

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

2. 特別小心返回值。

當出現(xiàn)錯誤時，會返回負值；
當字符串長度小于size時，返回打印到目的內存的實際字符串長度（不包括'\0'）;
當字符串長度大于等于size時，盡管字符串會被截斷（只有size-1個字符串被打印到目的內存），但是返回值卻會返回源字符串的實際長度（即假設目的內存無限大，總是能寫下源字符串）。

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

NOTE：有一些寫法會利用snprintf的這個特點來確定合適的目的內存大小，例如：

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));