cwk_path_change_root.md (1990B)
1 --- 2 title: cwk_path_change_root 3 description: Changes the root of a path. 4 --- 5 6 _(since v1.2.0)_ 7 Changes the root of a path. 8 9 ## Description 10 ```c 11 size_t cwk_path_change_root(const char *path, const char *new_root, 12 char *buffer, size_t buffer_size); 13 ``` 14 15 This function changes the root of a path. It does not normalize the result. 16 The result will be written to a buffer, which might be truncated if the 17 buffer is not large enough to hold the full path. However, the truncated 18 result will always be null-terminated. The returned value is the amount of 19 characters which the resulting path would take if it was not truncated 20 (excluding the null-terminating character). 21 22 **Note:** This function does not normalize the resulting path. You can use 23 **[cwk_path_normalize]({{ site.baseurl }}{% link reference/cwk_path_normalize.md %})** 24 to do so. The new root may contain separators which will introduce new segments. 25 If the submitted path does not have any root, the new root will be prepended to 26 the path. 27 28 ## Parameters 29 * **path**: The original path which will get a new root. 30 * **new_root**: The new root which will be placed in the path. 31 * **buffer**: The output buffer where the result is written to. 32 * **buffer_size**: The size of the output buffer where the result is written 33 to. 34 35 ## Return Value 36 Returns the total amount of characters of the new path. 37 38 ## Example 39 ```c 40 #include <cwalk.h> 41 #include <stdio.h> 42 #include <stddef.h> 43 #include <stdlib.h> 44 45 int main(int argc, char *argv[]) 46 { 47 char buffer[FILENAME_MAX]; 48 49 cwk_path_set_style(CWK_STYLE_WINDOWS); 50 51 cwk_path_change_root("C:\\test.txt", "D:\\", buffer, 52 sizeof(buffer)); 53 54 printf("The new path: '%s'", buffer); 55 56 return EXIT_SUCCESS; 57 } 58 ``` 59 60 Ouput: 61 ``` 62 The new path: 'D:\another.txt' 63 ``` 64 65 ## Changelog 66 67 | Version | Description | 68 |------------|--------------------------------------------------------| 69 | **v1.2.0** | The function is introduced. |