Функции библиотеки C -snprintf()
Стандартная библиотека C - <stdio.h>
Описание
snprintf() — это стандартная библиотечная функция языка C, используемая для форматирования и вывода строки, а также записи результата в указанный буфер. В отличие от sprintf(), snprintf() ограничивает количество выводимых символов, чтобы избежать переполнения буфера.
иsprintf()Разница в том, что функция snprintf() предоставляет параметр size, который может предотвратить переполнение буфера. Если длина форматированной строки превышает size-1, snprintf() запишет только size-1 символов и добавит нулевой символ (\0) в конец строки, чтобы обозначить её завершение.
Объявление
Ниже приведено объявление функции snprintf().
int snprintf ( char * str, size_t size, const char * format, ... );
int snprintf(char *str, size_t size, const char *format, ...)Пусть переменные аргументы будут установлены(...)в соответствии сformatФорматирует в строку и копирует строку вstrСреди них,sizeМаксимальное количество символов для записи; если оно превышаетsizeоно будет усечено, и будет записано не более size-1 символов.
Параметр
- str-- строка назначения, указатель на массив символов, используемый для хранения отформатированной строки.
- size-- размер массива символов.
- format-- строка формата.
- ...-- Переменные аргументы, переменное число аргументов, форматируемых в соответствии с директивами форматирования в format.
Возвращаемое значение
Возвращаемое значение — целое число:
-
В случае успеха возвращает число символов, которые были бы записаны (не считая завершающего нулевого символа), даже если это значение больше size.
-
При возникновении ошибки кодирования возвращается отрицательное значение.
Пример
В следующем примере демонстрируется использование функции snprintf().
Пример
int main()
{
char buffer[50];
char* s = "examplecom";
// Считать строку и сохранить её в buffer.
int j = snprintf(buffer, 6, "%s\n", s);
// Вывести buffer и количество символов.
printf("строка:\n%s\nколичество символов = %d\n", buffer, j);
return 0;
}
Результат вывода:
string: runoo character count = 10
Вот пример, демонстрирующий, как использовать%fСпецификатор формата для вывода числа с плавающей запятой одинарной точности в snprintf():
Пример
int main() {
char buffer[50];
float x = 3.1415926;
int len = snprintf(buffer, 50, "x = %f", x);
printf("%s\n", buffer);
printf("Записано символов: %d\n", len);
return 0;
}
Результат вывода:
x = 3.141593 Written characters: 12
В приведённом выше примере snprintf() записывает строку "x = 3.141593" в буфер и возвращает длину строки, которая равна 12. Поскольку размер буфера равен 50, в конце строки будет нулевой символ. Наконец, программа выводит строку, содержащуюся в буфере, и количество символов, возвращённое snprintf().
Примечания:
размер буфера:
snprintf()Функция ограничивает количество выводимых символов, но нужно убедиться, что размер переданного буфера достаточно велик для размещения отформатированной строки. В противном случае строка может быть усечена, что приведёт к потере информации.Терминатор строки:
snprintf()Функция добавляет нулевой символ в конце буфера в качестве терминатора строки, но этот символ не учитывается в возвращаемом значении. Поэтому при использованииsnprintf()При выводе строки нужно убедиться, что размера буфера достаточно для хранения всех символов строки, а также завершающего нулевого символа.Строка формата: При использовании
snprintf()При форматировании строки нужно убедиться, что спецификаторы формата в строке формата соответствуют типам переменных аргументов. В противном случае результат вывода может содержать ошибки.Возвращаемое значение:
snprintf()Возвращаемое значение функции — это количество символов, записанных в буфер, не считая нулевого символа в конце строки. Если возвращаемое значение равно размеру буфера, это означает, что результат вывода был усечён.Переменные аргументы:
snprintf()Переменные аргументы функции передаются через...Это означает, что переменные аргументы должны передаваться с использованием типов, соответствующих спецификаторам формата. При использовании переменных аргументов следует избегать использования неинициализированных переменных; в противном случае могут возникнуть непредсказуемые результаты.
В итоге, при использовании функции snprintf() необходимо обращать внимание на такие вопросы, как размер буфера, завершающий символ строки, строка формата, возвращаемое значение и переменные аргументы, чтобы обеспечить правильность результата вывода.
Другие расширения