How can I return a character array from a function in C?

by

You’ve got several options:

1) Allocate your array on the heap using malloc(), and return a pointer to it. You’ll also need to keep track of the length yourself:

void give_me_some_chars(char **arr, size_t *arr_len)
{
    /* This function knows the array will be of length 2 */
    char *result = malloc(2);

    if (result) {
        result[0] = 'c';
        result[1] = 'a';
    }

    /* Set output parameters */
    *arr = result;
    *arr_len = 2;
}

void test(void)
{
    char *ar;
    size_t ar_len;
    int i;

    give_me_some_chars(&ar, &ar_len);

    if (ar) {
        printf("Array:\n");
        for (i=0; i<ar_len; i++) {
            printf(" [%d] = %c\n", i, ar[i]);
        }
        free(ar);
    }
}

2) Allocate space for the array on the stack of the caller, and let the called function populate it:

#define ARRAY_LEN(x)    (sizeof(x) / sizeof(x[0]))

/* Returns the number of items populated, or -1 if not enough space */
int give_me_some_chars(char *arr, int arr_len)
{
    if (arr_len < 2)
        return -1;

    arr[0] = 'c';
    arr[1] = 'a';

    return 2;
}

void test(void)
{
    char ar[2];
    int num_items;

    num_items = give_me_some_chars(ar, ARRAY_LEN(ar));

    printf("Array:\n");
    for (i=0; i<num_items; i++) {
        printf(" [%d] = %c\n", i, ar[i]);
    }
}

DO NOT TRY TO DO THIS

char* bad_bad_bad_bad(void)
{
    char result[2];      /* This is allocated on the stack of this function
                            and is no longer valid after this function returns */

    result[0] = 'c';
    result[1] = 'a';

    return result;    /* BAD! */
}

void test(void)
{
    char *arr = bad_bad_bad_bad();

    /* arr is an invalid pointer! */
}

More Related Contents:

  1. Returning Arrays/Pointers from a function
  2. Changing array inside function in C
  3. C – SizeOf Pointers
  4. When is an array name or a function name ‘converted’ into a pointer ? (in C)
  5. C pointer notation compared to array notation: When passing to function
  6. C array pointer increment
  7. Is an array name a pointer?
  8. With arrays, why is it the case that a[5] == 5[a]?
  9. Returning an array using C
  10. How do you pass a function as a parameter in C?
  11. Why does a C-Array have a wrong sizeof() value when it’s passed to a function? [duplicate]
  12. Function pointers and address of a function
  13. Exceptions to array decaying into a pointer?
  14. Allocate memory 2d array in function C
  15. Why do arrays in C decay to pointers?
  16. Pointer address in a C multidimensional array
  17. C – Difference between “char var[]” and “char *var”?
  18. C++ correct way to return pointer to array from function
  19. Literal string initializer for a character array
  20. Are a, &a, *a, a[0], &a[0] and &a[0][0] identical pointers?
  21. Why can’t I treat an array like a pointer in C?
  22. Manipulate multidimensional array in a function
  23. Pointer to 2D arrays in C
  24. What’s the difference between array and &array?
  25. How to calculate size of array from pointer variable?
  26. Pointer to array of unspecified size “(*p)[]” illegal in C++ but legal in C
  27. Pointer expressions: **ptr++, *++*ptr and ++**ptr use
  28. Function returning array but main showing garbage [duplicate]
  29. Function pointer as a member of a C struct
  30. How can I malloc a struct array inside a function? Code works otherwise

Leave a Comment