X-Git-Url: http://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=ccan%2Fstr_talloc%2Fstr_talloc.h;h=c6e6a84bb00d64a496973d5a756ac31d993c9261;hp=3c65f9f84691ef68e0f1d9e695e59b3edba0ddae;hb=c438ec17d7b2efe76e56e5fc5ab88bd4a02735e8;hpb=fa64b4599366818ea546c7db026f37d987d181a8 diff --git a/ccan/str_talloc/str_talloc.h b/ccan/str_talloc/str_talloc.h index 3c65f9f8..c6e6a84b 100644 --- a/ccan/str_talloc/str_talloc.h +++ b/ccan/str_talloc/str_talloc.h @@ -1,3 +1,4 @@ +/* Licensed under LGPLv2.1+ - see LICENSE file for details */ #ifndef CCAN_STR_TALLOC_H #define CCAN_STR_TALLOC_H #include @@ -8,7 +9,6 @@ * @ctx: the context to tallocate from (often NULL) * @string: the string to split * @delims: delimiters where lines should be split. - * @nump: optional pointer to place resulting number of lines * * This function splits a single string into multiple strings. The * original string is untouched: an array is allocated (using talloc) @@ -16,8 +16,9 @@ * in empty substrings. By definition, no delimiters will appear in * the substrings. * - * The final char * in the array will be NULL, so you can use this or - * @nump to find the array length. + * The final char * in the array will be NULL, talloc_array_length() of the + * returned value is 1 greater than the number of valid elements in + * the array. * * Example: * #include @@ -29,7 +30,7 @@ * unsigned int i, long_lines = 0; * * // Can only fail on out-of-memory. - * lines = strsplit(NULL, string, "\n", NULL); + * lines = strsplit(NULL, string, "\n"); * for (i = 0; lines[i] != NULL; i++) * if (strlen(lines[i]) > 80) * long_lines++; @@ -37,8 +38,7 @@ * return long_lines; * } */ -char **strsplit(const void *ctx, const char *string, const char *delims, - unsigned int *nump); +char **strsplit(const void *ctx, const char *string, const char *delims); /** * strjoin - Join an array of substrings into one long string @@ -56,7 +56,7 @@ char **strsplit(const void *ctx, const char *string, const char *delims, * { * char **lines, *ret; * - * lines = strsplit(NULL, string, "\n", NULL); + * lines = strsplit(NULL, string, "\n"); * ret = strjoin(NULL, lines, "-- EOL\n"); * talloc_free(lines); * return ret;