cwk_path_change_basename.md (2197B)
1 --- 2 title: cwk_path_change_basename 3 description: Changes the basename of a file path. 4 --- 5 6 _(since v1.2.0)_ 7 Changes the basename of a file path. 8 9 ## Description 10 ```c 11 size_t cwk_path_change_basename(const char *path, const char *new_basename, 12 char *buffer, size_t buffer_size); 13 ``` 14 15 This function changes the basename of a file path. This function will not 16 write out more than the specified buffer can contain. However, the generated 17 string is always null-terminated - even if not the whole path is written out. 18 The function returns the total number of characters the complete buffer would 19 have, even if it was not written out completely. The path may be the same 20 memory address as the buffer. 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. Separators before and after the submitted basename will be trimmed, 25 but not removed from the source path. The value may contain separators which 26 will introduce new segments. If the submitted path does not have any segments, 27 the basename will be appended as a new segment. 28 29 ## Parameters 30 * **path**: The original path which will be used for the modified path. 31 * **new_basename**: The new basename which will replace the old one. 32 * **buffer**: The buffer where the changed path will be written to. 33 * **buffer_size**: The size of the result buffer where the changed path is written to. 34 35 ## Return Value 36 Returns the size which the complete new path would have if it was not truncated. 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_basename("C:\\test.txt", "another.txt", 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: 'C:\another.txt' 63 ``` 64 65 ## Changelog 66 67 | Version | Description | 68 |------------|--------------------------------------------------------| 69 | **v1.2.0** | The function is introduced. |