getFolder

 

getFolder

Retourne un objet représentant l'un des répertoires standard.

Méthode de

Objet Install

Syntaxe

FileSpecObject getFolder (
   Chaîne FolderName);
FileSpecObject getFolder (
   Chaîne folderName,
   Chaîne subDirectory);
FileSpecObject getFolder (
   Objet localDirSpec,
   Chaîne subDirectory);

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 FileSpecObject représentant un répertoire obtenu par les méthodes getComponentFolder ou getFolder.

Retour

Un code d'erreur entier. Pour la liste des valeurs possibles, voir Codes retournés.

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) :

"Chrome"
"Components"
"Current User"
"Defaults"
"file:///"
"OS Drive"
"Plugins"
"Preferences"
"Profile"
"Program"
"Temporary"

"Mac Apple Menu"
"Mac Control Panel"
"Mac Desktop"
"Mac Documents"
"Mac Extension"
"Mac Fonts"
"Mac Shutdown"
"Mac Startup"
"Mac System"
"Mac Trash"
"Mac Preferences"

"MacOSX Default Download"
"MacOSX Home"
"MacOSX Internet Sites"
"MacOSX Local Applications"
"MacOSX Local Desktop"
"MacOSX Local Documents"
"MacOSX Local Frameworks"
"MacOSX Local Internet PlugIn"
"MacOSX Local Preferences"
"MacOSX Movie Documents"
"MacOSX Music Documents"
"MacOSX Picture Documents"
"MacOSX User Applications"
"MacOSX User Desktop"
"MacOSX User Documents"
"MacOSX User Frameworks"
"MacOSX User Internet PlugIn"
"MacOSX User Preferences"

"Unix Lib"
"Unix Local"

"Windows"
"Win AppData"
"Win Common Files"
"Win Desktop"
"Win Desktop Common"
"Win Program Files"
"Win Programs"
"Win Programs Common"
"Win StartMenu"
"Win StartMenu Common"
"Win Startup"
"Win Startup Common"
"Win System"

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 <tt>Win</tt>, <tt>Mac</tt> ou <tt>Unix</tt> sont spécifiques à leur plate-forme respective. Il faut donc faire attention à leur utilisation, car ils rendent l'installation spécifique à une plate-forme.

Exemple

Pour récupérer un objet représentant le répertoire standard des plugins, on peut utiliser l'appel suivant :

plugindir = getFolder("Plugins");

Interwiki Language Links

Étiquettes et contributeurs liés au document

 Contributeurs à cette page : teoli, Kyodev, Fredchat
 Dernière mise à jour par : teoli,