{"id":5452,"date":"2022-07-23T00:01:54","date_gmt":"2022-07-23T07:01:54","guid":{"rendered":"https:\/\/c-for-dummies.com\/blog\/?p=5452"},"modified":"2022-07-16T11:13:00","modified_gmt":"2022-07-16T18:13:00","slug":"returning-a-non-static-string","status":"publish","type":"post","link":"https:\/\/c-for-dummies.com\/blog\/?p=5452","title":{"rendered":"Returning a Non-Static String"},"content":{"rendered":"

It’s possible to return a string created in a function without declaring it static<\/em>. This trick requires some understanding of how functions return values. Nerd alert!
\n
\nFunctions in C return only single values. If you want to return multiple values, you can pack them into a structure or you can pass pointers as arguments. To return an array declared in a function, such as a char<\/em> array or string, you must assign its value as static<\/em>. Otherwise, like all variables used in a function, its value is discarded when the function ends.<\/p>\n

Internally (and forgive my inner nerd for a paragraph), functions return single values by pushing them onto the stack. Only one value is pushed, which can be an int<\/em>, float<\/em>, char<\/em>, struct<\/em>, or an address (pointer). None of these items need be declared static<\/em> within the function as the value is pushed onto the stack. The storage allocated for the variable is lost when the function exits.<\/p>\n

The following code shows my binString()<\/em> function<\/a>, which accepts an 8-bit value and returns it as an 8-character string represent a binary number. The bin[]<\/code> array is declared static<\/em> at Line 6.<\/p>\n

2022_07_23-Lesson-a.c<\/a><\/h3>\n
\r\n#include <stdio.h>\r\n\r\nchar *binString(unsigned char n)\r\n{\r\n    const int width = 8;        \/* dealing the 8-bit bytes *\/<\/span>\r\n    static char bin[width+1];    \/* +1 for the null char *\/<\/span>\r\n    int x;\r\n\r\n    \/* test each bit and set a character for its value *\/<\/span>\r\n    for(x=0;x<width;x++)\r\n    {\r\n        bin[x] = n & 0x80 ? '1' : '0';\r\n        n <<= 1;\r\n    }\r\n    bin[width] = '\\0';        \/* cap the string *\/<\/span>\r\n\r\n    return(bin);\r\n}\r\n\r\nint main()\r\n{\r\n    int value;\r\n\r\n    printf(\"Enter an integer value, 0 to 255: \");\r\n    scanf(\"%d\",&value);\r\n    printf(\"Binary value is %s\\n\",binString((unsigned char)value));\r\n\r\n    return(0);\r\n}<\/pre>\n
Here’s a sample run:<\/p>\n
Enter an integer value, 0 to 255: 237
\nBinary value is 11101101<\/code><\/p>\n
If I remove the static<\/em> classifier from Line 6 and recompile, I see a warning: warning: address of stack memory associated with local variable 'bin' returned<\/code> This message means that the return value (on the stack) references a location that no longer exists. Here’s the output:<\/p>\n
Enter an integer value, 0 to 255: 237
\nBinary value is <\/code><\/p>\n
The char<\/em> array must be declared static<\/em> or its contents are lost.<\/p>\n
Pointers can be pushed to the stack, so returning a pointer’s value (address) doesn’t require that the pointer be static<\/em>. The pointer’s memory must be allocated, of course, as copying an array’s base to a pointer just returns the address of unallocated memory, which is bad.<\/p>\n
No, to retain a string created in a function, its memory must be allocated within the function, as this improvement to the code demonstrates:<\/p>\n
2022_07_23-Lesson-b.c<\/a><\/h3>\n
\r\n#include <stdio.h>\r\n#include <stdlib.h>\r\n\r\nchar *binString(unsigned char n)\r\n{\r\n    const int width = 8;        \/* 8-bit bytes *\/<\/span>\r\n    char *bin;        \/* string storage *\/<\/span>\r\n    int x;\r\n\r\n    \/* allocate storage *\/<\/span>\r\n    bin = malloc( width * sizeof(char) +1 );\r\n    if( bin==NULL )\r\n        exit(1);\r\n\r\n    \/* fill storage *\/<\/span>\r\n    for(x=0;x<width;x++)\r\n    {\r\n        bin[x] = n & 0x80 ? '1' : '0';\r\n        n <<= 1;\r\n    }\r\n    bin[width] = '\\0';\r\n\r\n    return(bin);\r\n}\r\n\r\nint main()\r\n{\r\n    int value;\r\n\r\n    printf(\"Enter an integer value, 0 to 255: \");\r\n    scanf(\"%d\",&value);\r\n    printf(\"Binary value is %s\\n\",binString((unsigned char)value));\r\n\r\n    return(0);\r\n}<\/pre>\n
The char<\/em> pointer bin<\/code> (Line 7) need not be static<\/em>. Its memory is allocated at Line 11. The address is saved, which is returned from the function intact.<\/p>\n
Unlike other functions where memory is allocated, you do not want to free this memory in the function! Wait until after you’re done using the string. If this program didn’t quit immediately after output, I would set a free()<\/em> statement in the code to release the allocated memory. Otherwise, the string can be used outside the binString()<\/em> function as you wish, no need to declare it static<\/em>.<\/p>\n","protected":false},"excerpt":{"rendered":"
To return a string from a function as a char<\/em> array, it must be static — not so for a pointer. Continue reading →<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[2],"tags":[],"class_list":["post-5452","post","type-post","status-publish","format-standard","hentry","category-main"],"_links":{"self":[{"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=\/wp\/v2\/posts\/5452","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=5452"}],"version-history":[{"count":4,"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=\/wp\/v2\/posts\/5452\/revisions"}],"predecessor-version":[{"id":5462,"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=\/wp\/v2\/posts\/5452\/revisions\/5462"}],"wp:attachment":[{"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=5452"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=5452"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=5452"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}