cwk_path_change_extension.md (2194B)
1 --- 2 title: cwk_path_change_extension 3 description: Changes the extension of a file path. 4 --- 5 6 _(since v1.2.0)_ 7 Changes the extension of a file path. 8 9 ## Description 10 ```c 11 size_t cwk_path_change_extension(const char *path, const char *new_extension, 12 char *buffer, size_t buffer_size); 13 ``` 14 15 This function changes the extension of a file name. The function will append 16 an extension if the basename does not have an extension, or use the extension 17 as a basename if the path does not have a basename. This function will not 18 write out more than the specified buffer can contain. However, the generated 19 string is always null-terminated - even if not the whole path is written out. 20 The function returns the total number of characters the complete buffer would 21 have, even if it was not written out completely. The path may be the same 22 memory address as the buffer. 23 24 **Note:** This function does not normalize the resulting path. You can use 25 **[cwk_path_normalize]({{ site.baseurl }}{% link reference/cwk_path_normalize.md %})** 26 to do so. 27 28 **Note:** If the ``new_extension`` parameter starts with a dot, the first dot will 29 be ignored when the new extension is appended. 30 31 ## Parameters 32 * **path**: The path which will be used to make the change. 33 * **new_extension**: The extension which will be placed within the new path. 34 * **buffer**: The output buffer where the result will be written to. 35 * **buffer_size**: The size of the output buffer where the result will be written to. 36 37 ## Return Value 38 Returns the total size which the output would have if it was not truncated. 39 40 ## Example 41 ```c 42 #include <cwalk.h> 43 #include <stdio.h> 44 #include <stddef.h> 45 #include <stdlib.h> 46 47 int main(int argc, char *argv[]) 48 { 49 char buffer[FILENAME_MAX]; 50 51 cwk_path_set_style(CWK_STYLE_WINDOWS); 52 53 cwk_path_change_extension("C:\\test.txt", "md", buffer, 54 sizeof(buffer)); 55 56 printf("The new path: '%s'", buffer); 57 58 return EXIT_SUCCESS; 59 } 60 ``` 61 62 Ouput: 63 ``` 64 The new path: 'C:\test.md' 65 ``` 66 67 ## Changelog 68 69 | Version | Description | 70 |------------|--------------------------------------------------------| 71 | **v1.2.0** | The function is introduced. |