cwk_path_is_absolute.md (1821B)
1 --- 2 title: cwk_path_is_absolute 3 description: Determine whether the path is absolute or not. 4 --- 5 6 _(since v1.0.0)_ 7 Determine whether the path is absolute or not. 8 9 ## Description 10 ```c 11 bool cwk_path_is_absolute(const char *path); 12 ``` 13 This function checks whether the path is an absolute (fully qualified) path or not. A path is considered to be absolute if the root ends with a separator. 14 15 ## Parameters 16 * **path**: The path which will be checked. 17 18 ## Return Value 19 Returns ``true`` if the path is absolute or ``false`` otherwise. 20 21 ## Outcomes 22 23 | Style | Path | Result | 24 |---------|--------------------------|-----------| 25 | UNIX | ``/test/`` | ``true`` | 26 | UNIX | ``test.txt`` | ``false`` | 27 | UNIX | ``C:\test.txt`` | ``false`` | 28 | UNIX | ``\folder\`` | ``false`` | 29 | WINDOWS | ``/test.txt`` | ``true`` | 30 | WINDOWS | ``\test.txt`` | ``true`` | 31 | WINDOWS | ``C:\test.txt`` | ``true`` | 32 | WINDOWS | ``\\server\folder\data`` | ``true`` | 33 | WINDOWS | ``\\.\folder\data`` | ``true`` | 34 | WINDOWS | ``\\?\folder\data`` | ``true`` | 35 | WINDOWS | ``C:test.txt`` | ``false`` | 36 | WINDOWS | ``..\hello\world.txt`` | ``false`` | 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 if(cwk_path_is_absolute("/my/path.txt")) { 48 printf("The root is absolute."); 49 } else { 50 printf("The root is relative."); 51 } 52 53 return EXIT_SUCCESS; 54 } 55 ``` 56 57 Ouput: 58 ``` 59 The root is absolute. 60 ``` 61 62 ## Changelog 63 64 | Version | Description | 65 |------------|--------------------------------------------------------| 66 | **v1.0.0** | The function is introduced. |