cwk_path_change_segment.md (2089B)
1 --- 2 title: cwk_path_change_segment 3 description: Changes the content of a segment. 4 --- 5 6 _(since v1.2.0)_ 7 Changes the content of a segment. 8 9 ## Description 10 ```c 11 size_t cwk_path_change_segment(struct cwk_segment *segment, const char *value, 12 char *buffer, size_t buffer_size); 13 ``` 14 15 This function overrides the content of a segment to the submitted value and 16 outputs the whole new path to the submitted buffer. The result might require 17 less or more space than before if the new value length differs from the 18 original length. The output is truncated if the new path is larger than the 19 submitted buffer size, but it is always null-terminated. The source of the 20 segment and the submitted buffer may be the same. 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 value will be trimmed. The value may 25 contain separators which will introduce new segments. 26 27 ## Parameters 28 * **segment**: The segment which will be modifier. 29 * **value**: The new content of the segment. 30 * **buffer**: The buffer where the modified path will be written to. 31 * **buffer_size**: The size of the output buffer. 32 33 ## Return Value 34 Returns the total size which would have been written if the output was not 35 truncated. 36 37 ## Example 38 ```c 39 #include <cwalk.h> 40 #include <stdio.h> 41 #include <stddef.h> 42 #include <stdlib.h> 43 44 int main(int argc, char *argv[]) 45 { 46 const char *path; 47 char buffer[FILENAME_MAX]; 48 struct cwk_segment segment; 49 50 path = "/this/cool/path/"; 51 if (!cwk_path_get_first_segment(path, &segment)) { 52 return EXIT_FAILURE; 53 } 54 55 cwk_path_change_segment(&segment, "other", buffer, sizeof(buffer)); 56 57 printf("The new path: '%s'", buffer); 58 59 return EXIT_SUCCESS; 60 } 61 ``` 62 63 Ouput: 64 ``` 65 The new path: '/other/cool/path/' 66 ``` 67 68 ## Changelog 69 70 | Version | Description | 71 |------------|--------------------------------------------------------| 72 | **v1.2.0** | The function is introduced. |