cwk_path_join_multiple.md (1972B)
1 --- 2 title: cwk_path_join_multiple 3 description: Joins multiple paths together. 4 --- 5 6 _(since v1.1.0)_ 7 Joins multiple paths together. 8 9 ## Description 10 ```c 11 size_t cwk_path_join_multiple(const char **paths, char *buffer, 12 size_t buffer_size); 13 ``` 14 This function generates a new path by joining multiple paths together. It will remove double separators, and unlike [cwk_path_get_absolute]({{ site.baseurl }}{% link reference/cwk_path_get_absolute.md %}) it permits the use of multiple relative paths to combine. The last path of the submitted string array must be set to NULL. The result will be written to a buffer, which might be truncated if the buffer is not large enough to hold the full path. However, the truncated result will always be null-terminated. The returned value is the amount of characters which the resulting path would take if it was not truncated (excluding the null-terminating character). 15 16 ## Parameters 17 * **paths**: An array of paths which will be joined. 18 * **buffer**: The buffer where the result will be written to. 19 * **buffer_size**: The size of the result buffer. 20 21 ## Return Value 22 Returns the total amount of characters of the full, combined path. 23 24 ## Outcomes 25 See [cwk_path_join]({{ site.baseurl }}{% link reference/cwk_path_join.md %}) for examples how paths are joined together. 26 27 ## Example 28 ```c 29 #include <cwalk.h> 30 #include <stdio.h> 31 #include <stddef.h> 32 #include <stdlib.h> 33 34 int main(int argc, char *argv[]) 35 { 36 char buffer[FILENAME_MAX]; 37 char paths[3]; 38 39 paths[0] = "hello/there"; 40 paths[1] = "../world"; 41 paths[2] = NULL; 42 cwk_path_join_multiple(paths, buffer, sizeof(buffer)); 43 printf("The combined path is: %s", buffer); 44 45 return EXIT_SUCCESS; 46 } 47 ``` 48 49 Ouput: 50 ``` 51 The combined path is: hello/world 52 ``` 53 54 ## Changelog 55 56 | Version | Description | 57 |------------|--------------------------------------------------------| 58 | **v1.1.0** | The function is introduced. |