cwk_path_get_absolute.md (2511B)
1 --- 2 title: cwk_path_get_absolute 3 description: Generates an absolute path based on a base. 4 --- 5 6 _(since v1.0.0)_ 7 Generates an absolute path based on a base. 8 9 ## Description 10 ```c 11 size_t cwk_path_get_absolute(const char *base, const char *path, char *buffer, 12 size_t buffer_size); 13 ``` 14 15 This function generates an absolute path based on a base path and another path. It is guaranteed to return an absolute path. If the second submitted path is absolute, it will override the base path. 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). 16 17 ## Parameters 18 * **base**: The absolute base path on which the relative path will be applied. 19 * **path**: The relative path which will be applied on the base path. 20 * **buffer**: The buffer where the result will be written to. 21 * **buffer_size**: The size of the result buffer. 22 23 ## Return Value 24 Returns the total amount of characters of the new absolute path. 25 26 ## Outcomes 27 28 | Base | Path | Result | 29 |----------------------|---------------------|-----------------------| 30 | ``/hello/there`` | ``../../../../../`` | ``/`` | 31 | ``/hello//../there`` | ``test//thing`` | ``/there/test/thing`` | 32 | ``hello/there`` | ``/test`` | ``/test`` | 33 | ``hello/there`` | ``test`` | ``/hello/there/test`` | 34 | ``/hello/there`` | ``/test`` | ``/test`` | 35 | ``/hello/there`` | ``..`` | ``/hello`` | 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 char buffer[FILENAME_MAX]; 47 48 cwk_path_get_absolute("/hello/there", "./world", buffer, sizeof(buffer)); 49 printf("The absolute path is: %s", buffer); 50 51 return EXIT_SUCCESS; 52 } 53 ``` 54 55 Ouput: 56 ``` 57 The absolute path is: /hello/there/world 58 ``` 59 60 ## Changelog 61 62 | Version | Description | 63 |------------|--------------------------------------------------------| 64 | **v1.2.4** | Fix for relative base path fallback on windows. | 65 | **v1.2.3** | Fix for path generation when reusing buffers. | 66 | **v1.0.0** | The function is introduced. |