Référence de l'API XPInstall:Objet Install:Méthodes:getFolder
Un article de MDC.
Sommaire |
[modifier] getFolder
Retourne un objet représentant l'un des répertoires standard.
[modifier] Méthode de
Objet Install
[modifier] Syntaxe
FileSpecObject getFolder ( Chaîne FolderName);
FileSpecObject getFolder ( Chaîne folderName, Chaîne subDirectory);
FileSpecObject getFolder ( Objet localDirSpec, Chaîne subDirectory);
[modifier] Paramètres
La méthode getFolder a les paramètres suivants :
folderName- Une chaîne représentant l'un des répertoires standard de Netscape. Il y a deux ensembles de valeurs possibles pour ce paramètre. Le premier ensemble contient tous les emplacements indépendants de la plate-forme. Le second ensemble contient les emplacements spécifiques à une plate-forme donnée. Vous êtes encouragés à utiliser des emplacements indépendants à la plate-forme. Voir la liste des emplacements des deux ensembles dans la section Description.
subDirectory- Une chaîne qui définit le nom d'un sous-répertoire. Si ce dernier n'existe pas, il est créé. Ce paramètre est disponible dans Netscape 6 et ultérieur et peut être sensible à la casse (en fonction du système d'exploitation).
localDirSpec- Un objet
FileSpecObjectreprésentant un répertoire obtenu par les méthodes getComponentFolder ou getFolder.
[modifier] Retour
Un code d'erreur entier. Pour la liste des valeurs possibles, voir Codes retournés.
[modifier] Description
La méthode getFolder obtient un objet représentant l'un des répertoires standard de Netscape, qui sera utilisé avec les méthodes addFile et getWinProfile.
La valeur de folderName doit être l'une des valeurs suivantes (informations basées sur la branche stable Mozilla 1.7, peuvent également être valables pour d'autres versions) :
|
|
|
|
|
|
|
La forme file:/// n'est valide que lorsque le paramètre subDirectory est utilisé. Elle doit être au format URL file: amputée de la partie file:///. Par exemple :
mydir = getFolder("file:///", "c|/mysoftco/somedir");
Remarquez l'utilisation de barre oblique (/), quelque soit la plate-forme.
Les dossiers dont les noms commencent par Win, Mac ou Unix sont spécifiques à leur plate-forme respective. Il faut donc faire attention à leur utilisation, car ils rendent l'installation spécifique à une plate-forme.
[modifier] Exemple
Pour récupérer un objet représentant le répertoire standard des plugins, on peut utiliser l'appel suivant :
plugindir = getFolder("Plugins");