fDirSize (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | Français

Functions for managing external files

See also

fDirSize (Function)

In french: fRepTaille

Returns the size of a directory in bytes.

Caution: The execution of this function may take quite a long time depending on the size of the directory to analyze.

Versions 15 and later

This function is now available for the Android applications.

This function is now available for the PHP sites.

New in version 15

This function is now available for the Android applications.

This function is now available for the PHP sites.

This function is now available for the Android applications.

This function is now available for the PHP sites.

Versions 17 and later

This function is now available for the iPhone/iPad applications.

New in version 17

This function is now available for the iPhone/iPad applications.

Versions 18 and later

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Example

ResSize is int
// Size of "C:\MyDocuments" directory
ResSize = fDirSize("C:\MyDocuments")
// Readable display
Info("The size of the directory is: " + LengthToString(ResSize))

ResSize is int
// Size of "MyDocuments" directory
ResSize = fDirSize("\MyDocuments")
// Readable display
Info("The size of the directory is: " + LengthToString(ResSize))

Syntax

<Result> = fDirSize(<Directory Path> [, <Options>])

<Result>: Integer

Size of the directory in bytes,
-1 if an error or an interruption occurred. To find out the error details, use ErrorInfo associated with the errMessage constant.
Note: the hidden files are taken into account when calculating the size of the directory.

<Directory Path>: Character string

Name and full (or relative) path of the directory to use (up to 260 characters). A UNC path can be used. The wildcard characters (*,?) are not allowed.
Versions 15 and later
This parameter can be in Ansi or Unicode format.
This parameter can correspond to a full path or to a relative path in relation to the current directory (returned by fCurrentDir). This parameter is case sensitive.
Reminder: In Android, the file system is read-only on the device and on the emulator. An application has the rights to write into its setup directory or into one of its sub-directories, as well as onto the external memory (SDCard).
New in version 15
This parameter can be in Ansi or Unicode format.
This parameter can correspond to a full path or to a relative path in relation to the current directory (returned by fCurrentDir). This parameter is case sensitive.
Reminder: In Android, the file system is read-only on the device and on the emulator. An application has the rights to write into its setup directory or into one of its sub-directories, as well as onto the external memory (SDCard).
This parameter can be in Ansi or Unicode format.
This parameter can correspond to a full path or to a relative path in relation to the current directory (returned by fCurrentDir). This parameter is case sensitive.
Reminder: In Android, the file system is read-only on the device and on the emulator. An application has the rights to write into its setup directory or into one of its sub-directories, as well as onto the external memory (SDCard).
This path must be a full path or a UNC path. It cannot be a relative path.
Versions 17 and later
This parameter can correspond to a full path or to a relative path in relation to the current directory (returned by fCurrentDir). This parameter is case sensitive.
Reminder: On iPhone/iPad, the file system is read-only on the device and on the emulator. An application has the rights to write into its setup directory or into one of its sub-directories.
New in version 17
This parameter can correspond to a full path or to a relative path in relation to the current directory (returned by fCurrentDir). This parameter is case sensitive.
Reminder: On iPhone/iPad, the file system is read-only on the device and on the emulator. An application has the rights to write into its setup directory or into one of its sub-directories.
This parameter can correspond to a full path or to a relative path in relation to the current directory (returned by fCurrentDir). This parameter is case sensitive.
Reminder: On iPhone/iPad, the file system is read-only on the device and on the emulator. An application has the rights to write into its setup directory or into one of its sub-directories.

<Options>: Integer constant or combination of constants (optional)

Type of browse performed for the directory files:
fdInterruptible The browse can be interrupted by pressing the ESC key. The function will return the name of directories listed until the interruption.
This constant has no effect.
frNotRecursive The browse is a non-recursive browse. The sub-directories are ignored.
frRecursive
(Default value) The browse is a recursive browse. The sub-directories are automatically taken into account.
fdIgnoreError If a directory cannot be browsed, it is ignored. If this constant is not specified, fDirSize returns an error.

Remarks

Managing errors

fDirSize generates an error in the following cases:

the specified directory does not exist,
the name of the directory is invalid,
the operation was interrupted by the user.

Component : wd250std.dll