Unexpected array behaviour with use of sprintf in C

Question

I am facing weird behaviour after apply sprintf: list[0] seems just gone away and result of strlen is 0. Then I try to apply strcpy, strlen meets expectation and returns 3. So my question is why sprintf will erase my list[0], how do I recover value of list[0] if I insist to apply sprintf? thanks in advance.

#include <stdio.h>
#include <stdlib.h>
#include <string.h>

void main() {
    char list[5][7] = { "One", "Two", "Three", "Four", "Five" };    
    char item[7];

    int i = 0;

    for (i = 0; i < 5; i++) {
        sprintf(item, "%-7s", list[i]);
        //strcpy(item, list[i]);
    }

    printf("%d", strlen(list[0]));
}

You need enough space to hold the null character at the end. Since you enforce a width of at least 7 chars, you need at least 8 chars. (Even that may fail for longer strings. Consider using snprintf, which guards against overflow at the risk of truncating the output.) — M Oehm
– M Oehm, Commented May 7, 2020 at 11:34
An char array of size 7 can hold a string of at most 6 characters plus 1 terminating null character. — Paul Ogilvie
– Paul Ogilvie, Commented May 7, 2020 at 11:34
@AtlasChiew: you can accept one of the answers by clicking on the grey checkmark below its score — chqrlie
– chqrlie, Commented May 11, 2020 at 19:59

chqrlie · Accepted Answer · 2020-05-07 12:58:09Z

Your code has undefined behavior because %-7s requires at least 8 bytes in the destination array: 7 for the left aligned string plus one for the null terminator. Note that if any of the strings were longer than 7 bytes, even more space would be required in the destination array.

This mistake might explain the observed behavior: sprintf writes 8 bytes to item, ie one byte too many, and if the array list starts in memory just after the end of item, its first byte would be overwritten with a null bytes causing list[0] to to be truncated and become an empty string with a length of 0.

You should use snprintf that prevents buffer overflow and make your array at least 8 bytes long.

Note also that main has a return type of int.

Here is a modified version:

#include <stdio.h>
#include <stdlib.h>
#include <string.h>

int main() {
    char list[5][7] = { "One", "Two", "Three", "Four", "Five" };    
    char item[8];

    for (int i = 0; i < 5; i++) {
        snprintf(item, sizeof item, "%-7s", list[i]);
    }
    printf("%d\n", strlen(list[0]));
    return 0;
}

Welgriv · Accepted Answer · 2020-05-07 12:17:39Z

5

As other said:

At this line: sprintf(item, "%-7s", list[i]); the item char array is supposed to be at least 8 bytes long to hold 7 characters + the end string byte \0.

Moreover sprintf is dangerous you should use snprintf instead.

edited May 7, 2020 at 12:17

answered May 7, 2020 at 11:39

Welgriv

8431 gold badge12 silver badges25 bronze badges

1 Comment

M.M Over a year ago

sprintf is not deprecated

Nima · Accepted Answer · 2020-05-07 12:12:03Z

1

I think it is the "%-7s" that's causing the problem

Since the strings are 6 characters long, isn't it better to use "%-6s" instead? the problem seems to get solved that way.

Edit: Or as mentioned by @Welgriv in the comments, set size of the char arrays to 8 to have 7 characters

edited May 7, 2020 at 12:12

answered May 7, 2020 at 11:36

Nima

3812 silver badges8 bronze badges

2 Comments

Welgriv Over a year ago

Or char item[8]; before. But regarding the list array your solution might be more coherent.

Nima Over a year ago

@chqrlie No, i don't think i have enough repuration to vote.

August Karlstrom · Accepted Answer · 2020-05-07 12:46:28Z

As pointed out in other replies, the field width in sprintf mustn't exceed the length of the array minus one. The real solution is to not hard code any values which can be calculated from previous declarations. The program below shows a more robust version:

#include <stdio.h>
#include <stdlib.h>
#include <string.h>

#define LEN(arr) ((int) (sizeof (arr) / sizeof (arr)[0]))

int main(void)
{
    char list[][7] = { "One", "Two", "Three", "Four", "Five" }; 
    char item[LEN(list[0])];

    int i = 0;

    for (i = 0; i < LEN(list); i++) {
        sprintf(item, "%-*s", LEN(list[0]) - 1, list[i]);
    }

    printf("%d", strlen(list[0]));
    return 0;
}

Now, say you want to change the length of the character arrays. Then you only need to change the value 7 to something else and the rest will follow.

See also https://en.wikipedia.org/wiki/Magic_number_(programming)#Unnamed_numerical_constants

Collectives™ on Stack Overflow

Unexpected array behaviour with use of sprintf in C

4 Answers 4

Comments

1 Comment

2 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

Comments

1 Comment

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related