NAME

       MLV_path.h - Ce fichier définit les prototypes des fonctions permettant de manipuler les chemins d'accès
       aux fichiers et répertoires.

SYNOPSIS

   Fonctions
       char * MLV_get_base_name (const char *path)
           Renvoie la chaîne de caractères après le dernier séparteur / dans un chemin donné en paramètre.
       char * MLV_get_directory_name (const char *path)
           Renvoie la chaîne de caractères s'étendant jusqu'au dernier séparateur / du chemin donné en
           paramètre.
       int MLV_path_is_absolute (const char *path)
           Teste si un chemin est absolu.
       int MLV_path_is_relative (const char *path)
           Teste si un chemin est relatif.
       int MLV_path_exists (const char *path)
           Teste si le chemin corespond au chemin d'un fichier ou dossier existant.
       int MLV_path_is_a_directory (const char *path)
           Vérifie si un chemin est associé à un répertoire.
       int MLV_path_is_a_file (const char *path)
           Vérifie si un chemin est associé à un fichier.
       char * MLV_build_path (const char *first_element,...)
           Construit en concaténant différents textes, une chaîne de caractères représentant un chemin dont les
           séparateurs corespondent aux spécifications de la plateforme sur laquel s'exécute le programme.
       char * MLV_build_path_v (char **elements)
           Même chose que MLV_build_path.
       char * MLV_get_current_directory ()
           Détermine le répertoire courant.
       const char * MLV_get_temporary_directory ()
           Détermine le répertoire temporaire.
       const char * MLV_get_home_directory ()
           Détermine le répertoire personnel de l'utilisateur courant.

Description détaillée

       Ce fichier définit les prototypes des fonctions permettant de manipuler les chemins d'accès aux fichiers
       et répertoires.

       Auteur:
           Adrien Boussicault

           Marc Zipstein

Documentation des fonctions

   char* MLV_build_path (const char * first_element,  ...)
       Construit en concaténant différents textes, une chaîne de caractères représentant un chemin dont les
       séparateurs corespondent aux spécifications de la plateforme sur laquel s'exécute le programme.

       Bogue
           Cette fonction ne fait que concaténer les differentes chaînes en mettant entre chaque chaîne un
           séparateur de répertoire compatible avec le système d'exploitation. Par contre, ce qui constitue le
           bug, il ne convertit pas chaque chaîne dans un format compatible avec celui du système
           d'exploitation.

       La chaîne de caractères doit être désallouée après utilisation.

       Paramètres:
           first_element La première chaîne à concaténer.
           ... Les autres éléments à concaténer.

       Renvoie:
           Le chemin vérifiant les normes de la plateforme hôte.

       Exemples:
           advanced/12_paths.c.

   char* MLV_build_path_v (char ** elements)
       Même chose que MLV_build_path. La chaîne de caractères doit être désallouée après utilisation.

       Paramètres:
           elements Les éléments à concaténer ensemble.

       Renvoie:
           Le chemin vérifiant les normes de la plateforme qui va exécuter le programme.

   char* MLV_get_base_name (const char * path)
       Renvoie la chaîne de caractères après le dernier séparteur / dans un chemin donné en paramètre. La chaîne
       de caractères doit être désallouée après utilisation.

       Paramètres:
           path Le chemin à analyser.

       Renvoie:
           Une chaîne de caractères.

       Exemples:
           advanced/12_paths.c.

   char* MLV_get_current_directory ()
       Détermine le répertoire courant. La chaîne de caractères doit être désallouée après utilisation.

       Renvoie:
           Le chemin du répertoire courant.

       Exemples:
           advanced/12_paths.c.

   char* MLV_get_directory_name (const char * path)
       Renvoie la chaîne de caractères s'étendant jusqu'au dernier séparateur / du chemin donné en paramètre. La
       chaîne de caractères doit être désallouée après utilisation.

       Paramètres:
           path Le chemin à analyser.

       Renvoie:
           Une chaîne de caractères.

       Exemples:
           advanced/12_paths.c.

   const char* MLV_get_home_directory ()
       Détermine le répertoire personnel de l'utilisateur courant. La chaîne de caractères doit être désallouée
       après utilisation.

       Renvoie:
           Le chemin du répertoire personnel.

       Exemples:
           advanced/12_paths.c.

   const char* MLV_get_temporary_directory ()
       Détermine le répertoire temporaire. Le répertoire temporaire est le répertoire dans lequel les
       applications ont le droit d'ajouter et de modifier des fichiers. Ce répertoire est génaralement vidé
       lorsque la machine est étteinte.

       La chaîne de caractères doit être désallouée après utilisation.

       Renvoie:
           Le chemin du répertoire temporaire.

       Exemples:
           advanced/12_paths.c.

   int MLV_path_exists (const char * path)
       Teste si le chemin corespond au chemin d'un fichier ou dossier existant.

       Paramètres:
           path Le chemin

       Renvoie:
           Renvoie 1 si le chemin est associé à un dossier ou à un fichier existant, 0 sinon.

       Exemples:
           advanced/12_paths.c.

   int MLV_path_is_a_directory (const char * path)
       Vérifie si un chemin est associé à un répertoire.

       Paramètres:
           path Le chemin

       Renvoie:
           Renvoie 1 si le chemin est associé à un dossier, 0 sinon.

       Exemples:
           advanced/12_paths.c.

   int MLV_path_is_a_file (const char * path)
       Vérifie si un chemin est associé à un fichier.

       Paramètres:
           path Le chemin

       Renvoie:
           Renvoie 1 si le chemin est associé à un fichier, 0 sinon.

       Exemples:
           advanced/12_paths.c.

   int MLV_path_is_absolute (const char * path)
       Teste si un chemin est absolu.

       Paramètres:
           path Le chemin

       Renvoie:
           Renvoie 1 si le chemin est absolue, 0 sinon.

       Exemples:
           advanced/12_paths.c.

   int MLV_path_is_relative (const char * path)
       Teste si un chemin est relatif.

       Paramètres:
           path Le chemin

       Renvoie:
           Renoie 1 si le chemin est relatif, 0 sinon.

       Exemples:
           advanced/12_paths.c.

Auteur

       Généré automatiquement par Doxygen pour MLV-3.1.0 à partir du code source.

MLV-3.1.0                                    Samedi 14 Janvier 2017                                MLV_path.h(3)