fDir (Function)

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Functions for managing external files

fDir

Presentation

Example

Caution: fDir keeps an access to the directory

Browsing directories

Windows

Using fDir in the threads

Equivalence

See also

fDir (Function)

In french: fRep

Finds a file or a directory. This search can be performed with wildcard characters (*,?).

Notes:

To check the file existence, use fFileExist.
To check the existence of a directory, disk or share, use fDirectoryExist.
To list the sub-directories of a directory, use fListDirectory.

Versions 15 and later

This function is now available for the Android applications.

New in version 15

This function is now available for the Android applications.

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

See additional examples

// Find the "C:\MyDirectory\MyFile.doc" file
ResSearch = fDir("C:\MyDirectory\MyFile.doc")

// Find the "C:\MyDirectory\MyFile.doc" file
ResSearch = fDir("C:\MyDirectory\MyFile.doc", frFile)

// Find the "C:\MyDirectory\" directory
ResSearch = fDir("C:\MyDirectory\", frDirectory)

// Find the first ".doc" file in the "C:\MyDirectory" directory
ResSearch = fDir("C:\MyDirectory\*.doc")

// Find the "\MyDirectory\MyFile.psw" file
ResSearch = fDir("C:\MyDirectory\MyFile.psw")

// Find the "\MyDirectory\MyFile.psw" file
ResSearch = fDir("C:\MyDirectory\MyFile.psw", frFile)

// Find the "\MyDirectory\" directory
ResSearch = fDir("\MyDirectory\", frDirectory)

// Find the first ".psw" file the in "\MyDirectory\" directory
ResSearch = fDir("C:\MyDirectory\*.psw")

Syntax

<Result> = fDir(<Name of Sought File or Directory> [, <Options>])

<Result>: Character string

Name of file (with its extension) or directory found.
Empty string ("") otherwise. To find out whether an error was generated by this function, use ErrorInfo associated with the errMessage constant.

<Name of Sought File or Directory>: Character string (with quotes)

Name and full (or relative) path of sought file or directory (up to 260 characters). A UNC path can be used. You have the ability to use wildcard characters (*,?) in the name of the file.
If this parameter is empty, the function continues and searches for the name of the next corresponding file (or directory): this allows you to list the files or directories belonging to a given directory.
If this parameter corresponds to a directory name, this name may (or may not) end with "\".
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.
If the "*.*" expression is used, only the files that have an extension will be copied.
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, 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, 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, an application has the rights to write into its setup directory or into one of its sub-directories.

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

Search options:
fPathUNICODE
Versions 15 and later
<Result> will be a character string in Unicode format.
This constant can be combined with frFile or frDirectory.
New in version 15
<Result> will be a character string in Unicode format.
This constant can be combined with frFile or frDirectory.
<Result> will be a character string in Unicode format.
This constant can be combined with frFile or frDirectory.
frFile
(Default value) Find a file.
frDirectory Find a directory.

Remarks

Caution: fDir keeps an access to the directory

The call to fDir locks the directory and prevents you from deleting it or from renaming it. To unlock the directory, add the following code line to your process:

fDir("")

Browsing directories

The browses of directories performed by fDir must not be nested.

fCopyFile must not be used when fDir is used in a loop for browsing directories.

Windows

In Windows, a file name or a directory name can contain lowercase and/or uppercase characters (the names of the files are not "case sensitive").

Therefore, you should not write:

IF fDir(FileName) = "TOTO" THEN Info("File found")

But you should write:

IF fDir(FileName) ~= "TOTO" THEN Info("File found")

Using fDir in the threads

fDir should not be used at the same time in two different threads.

Indeed, the last browse operation requested by fDir automatically replaces the current one.

Equivalence

The operating mode of fDir is equivalent to the operating mode of ceDir.

The only difference is:

fDir handles a file or a directory found on the Pocket PC from a WINDEV Mobile application.
ceDir handles a file or a directory found on the Pocket PC from a standard WINDEV application.

Component : wd240std.dll