Aide:DirGetSize.txt

Document original V3.3.6.1 :

###Function###
DirGetSize

###Description###
Returns the size in bytes of a given directory.

###Syntax###
DirGetSize ( "path" [, flag] )


###Parameters###
@@ParamTable@@
path
	The directory path to get the size from, e.g. "C:\Windows".
flag
	[optional] this flag determines the behaviour and result of the function,
	and can be a combination of the following:
	0 = (default)
	1 = Extended mode is On -> returns an array that contains extended information (see Remarks).
	2 = Don't get the size of files in subdirectories (recursive mode is Off)
@@End@@


###ReturnValue###
@@ReturnTable@@
Success:	Returns >= 0 the sizes
Failure:	Returns -1 and sets @error to 1 if the path doesn't exist.
@@End@@


###Remarks###
If the script is paused then this function is paused too and will only continue when the script continues!

If you use the extended mode then the array returned from this function is a single dimension array containing the following elements:
$array[0] = Size
$array[1] = Files count
$array[2] = Dirs Count


###Related###
None.

###Example###
@@IncludeExample@@

Document traduit V3.3.6.1 :

###Function###
DirGetSize

###Description###
Retourne la taille en octets d'un répertoire donné.


###Syntax###
DirGetSize ( "path" [, flag] )


###Parameters###
@@ParamTable@@
path
	Le chemin du répertoire dont on veut obtenir la taille. Ex : "C:\Windows".
flag
	[Optionnel] Ce paramètre détermine le comportement et le résultat de la fonction et peut être une combinaison de ce qui suit :
	0 = (défaut)
	1 = Le mode étendu est activé. Retourne un tableau qui contient les informations étendues (voir remarques).
	2 = Ne prend pas en compte la taille des fichiers des sous répertoires (le mode récursif est désactivé).
@@End@@


###ReturnValue###
@@ReturnTable@@
Succès:   Retourne la taille >=0.
Échec:    Retourne -1 et met @error à 1 si le chemin n'existe pas.
@@End@@


###Remarks###
Si le script est mis en pause alors cette fonction est mise en pause également et elle continuera quand le script sera reprit.

Si vous utilisez le mode étendu, alors le tableau retourné par cette fonction est un tableau à 1 dimension contenant les éléments suivants :
$array[0] = Taille
$array[1] = Nombre de fichiers
$array[2] = Nombre de répertoires


###Related###
Aucune.


###Example###
@@IncludeExample@@

Traducteur : scorp84

Contributeurs (pour les modifications avant le Wiki) : Tlem