ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

This content has been translated automatically.  Click here  to view the French version.
Help / WLanguage / WLanguage functions / Standard functions / External file functions
WINDEV
WindowsLinuxJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac Catalyst
Others
Stored procedures
Display only constants used by prefix syntaxes
ConstantDescriptionUsed by the functions
fAccessHandle the Date/Time of last file access.fDate, fTime
fcCopyUsed to continue the copy.fCopyFile
fCopyDir
fcIgnoreUsed to ignore the copy of a file.fCopyFile
fCopyDir
fCreationHandle the Date/Time of file creation.fDate, fTime
fcStopUsed to stop the copy permanently.fCopyFile
fCopyDir
fdCDRomDisc type: CD-ROM (and burners, DVD, etc.).fDriveInfo
fddDefaultThe data directory is automatically created if it does not exist.fDataDirCommon, fDataDirUser
fdDriveTypeType of information to be searched for: type of disc.fDriveInfo
fddWithoutCreationThe data directory is not created if it does not exist.fExtractPath
fDeleteDestinationIf the destination file already exists, it will be deleted then recreated.fMerge
fDeleteSource
  • The source file will be deleted as the split operation goes along.
  • The source files will be deleted as the merge operation goes along.
fSplit,
fMerge
fdFileNameSizeType of information to be searched for: maximum size of a file name on disk (in characters).fDriveInfo
fdFixedType of disk handled: fixed disk (hard disk).fDriveInfo
fdForbidVirtualFolderThe virtual directories are not listed.fSelectDir
fdFormerAspectAllows you to use the former directory picker (old style).fSelectDir
fdFreeSpaceType of information to be searched: disk space (in bytes).fDriveInfo
fdFullInformationReturns the entire information about the list of files and directories. fListFile,
New in version 2025
DriveListFile, DriveListFileGgl
fdIgnoreErrorIf a directory cannot be browsed, it is ignored.fDirSize
fdInterruptibleThe browse of the files/directories can be interrupted by pressing the ESC key.fListFile, fDirSize
fdInvalidType of disk handled: the path provided does not correspond to a disk.fDriveInfo
fDirectoryPortion of file path: different directories of the file (file name and extension are not returned).fExtractPath
fDirectoryPortion of file path: different directories of the file (file name and extension are not returned).fExtractPath
fdNbClusterType of information to be retrieved: number of disk clusters.fDriveInfo
fdNbSectorPerClusterType of information required: number of sectors per cluster.fDriveInfo
fdRAMType of disk handled: virtual disk.fDriveInfo
fdRemoteType of disk handled: network disk.fDriveInfo
fdRemovableDisk type: removable disk (floppy, zip, etc.).fDriveInfo
fDrivePortion of file path: unit name.fExtractPath
fdSectorSizeType of information to be searched: sector size (in bytes).fDriveInfo
fdSerialNumberType of information to search for: volume serial number.fDriveInfo
fdTotalSpaceType of information to be searched: total disk size (in bytes).fDriveInfo
fdUnknownUnknown type of disk.fDriveInfo
fdVolumeNameType of information to be searched for: volume name.fDriveInfo
fExtensionPortion of the file path: file extension, preceded by the ".".fExtractPath
fFilePortion of file path: file name (without extension).
Note: In previous versions, this constant was named fFileName.
fExtractPath
flChangeDirDirectory change: first file listed in a subdirectory.fListFile, fListDirectory, BurnerAddDirectory
flDirectorySame directory: listed file belonging to the same directory as the previous file.fListDirectory
flFileCharacteristics of listed file.fListFile, BurnerAddDirectory
flFirstFileThe listed file corresponds to the first directory file.fListFile, BurnerAddDirectory
fLinkPhysicalCreate a physical link.
A physical link is a file that can be accessed via several paths. The file deletion can be performed only when all physical links have been deleted.
fCreateLink
fLinkSymbolicCreate a symbolic link.
A symbolic link is a "pointer" to a file. The deletion of the symbolic link does not affect the pointed file. The deletion of the pointed file makes the symbolic link invalid.
fCreateLink
fLockEmptyFileUsed to lock a file, even if it is empty.fLock
fModifyHandle the Date/Time of last file modification.fDate, fTime
foAddFile opening mode: open file in "add" mode.fOpen
foAnsiUsed to manage an Ansi file when the "Use the Unicode strings at runtime" mode is enabled in the project configuration.
Mode used by default:
  • in the WINDEV and WEBDEV projects earlier than version 17,
  • in the configurations of WINDEV and WEBDEV projects that use the "Use Ansi strings at runtime" mode from version 17.
fLoadText,
fCreate,
fOpen,
fOpenTempFile
foAutomaticDeletionThe file will be automatically deleted when it is closed (with fClose or when the application is closed). If multiple applications are using the file, it will be automatically deleted when the last application closes it (when fClose is called, or at the end of the application).fCreate, fOpen, fOpenTempFile
foCreateFile opening mode: file creation.fOpen
foCreateIfNotFoundFile open mode: file creation only if file does not exist.
In previous versions, this constant was called foCreationIfNotFound.
fOpen
foReadFile access mode: open file in "read-only" mode.fOpen
foReadLockBlock file opening: file created read-only. The other applications cannot read the current file.fCreate, fOpen, fOpenTempFile
foReadWriteFile access mode: open file in "read/write" mode.fOpen
foSequentialAccessOptimizes the management of caches for the file by specifying to Windows that the file will be read from the beginning to the end.fOpen
foUnicodeUsed to manage a Unicode file when the "Use the Ansi strings at runtime" mode is enabled in the project configuration.
Mode used by default:
  • in the WINDEV Mobile projects regardless of the mode and version used,
  • in the configurations of WINDEV and WEBDEV projects that use the "Use Unicode strings at runtime" mode from version 17.
fLoadText,fCreate,
fOpen,
foWithoutDeletionThe file will not be automatically deleted when it is closed.fOpenTempFile
foWriteFile access mode: open file in "write-only" mode.fOpen
foWriteLockLock when file is opened: file created in write-only mode. The other applications cannot modify the current file.fCreate, fOpen, fOpenTempFile
fpBeginningOriginal position in the file: first byte of the file.fSeek
fpCurrentOriginal position in file: current position.fSeek
fpEndOriginal position in the file: last byte of the file.fSeek
frConfirmA confirmation is requested before overwriting a file or a directory (copy, move, etc.).fCopyFile, fCopyDir, fMoveDir
frDirectoryFind a directoryfDir
frelAllRelative path construction mode: Allows you to completely relativize the file path.fBuildRelativePath
fRelativePathUsed to return the parent directory in the format of a relative path.fParentDir
frelSubdirectoryOnlyRelative path construction mode: Relates the path to the parameter. <Chemin de reférence>. fBuildRelativePath
frFileFind a file.fDir
frNoHiddenDirectoryIf the frFullInformation constant is used, the hidden directories are not listed (attribute = "H").fListFile
frNoHiddenFileIf the frFullInformation constant is used, the hidden files are not listed (attribute = "H").fListFile
frNotRecursiveThe sub-directories are not processed.fListFile, fDirSize, DriveListFile, DriveListFileGgl
frProgressDisplays a progress window (progress bar)fCopyFile, fCopyDir, fMoveDir
frReadOnlyAlso deletes the read-only files. If this constant is not specified, the function will return False if read-only files must be deleted.fRemoveDir, fDelete
frRecursiveSubdirectories are processedfCopyFile, fListFile, fCopyDir, fMoveDir, fRemoveDir, DriveListFile, DriveListFileGgl
frToRecycleBinSends the file or the directory to the recycle bin of Windows instead of deleting it.fRemoveDir, fDelete
fselChangeSends the MessageSelect message to the calling WINDEV window whenever a click is performed on a file found in the file picker.fSelect
fselCreateOpens the file picker in creation mode ("Save" button).fSelect
fselExistOpening mode of the file picker:
  • with fselCrée: Returns the name of the selected file. If the file already exists, a dialog box displays and allows the user to overwrite the former file,
  • with fselOuvre Returns the name of the selected file only if it exists.
fSelect
fselMultiOpens the file picker in multi-selection mode. The user can select several files by pressing the "Ctrl" and "Shift" keys.
fselOpenOpens the file picker in opening mode ("Open" button).fSelect
fSeparatorPlatformThe separators (\ and /) will be replaced with the separator corresponding to the current platform.fSeparator
fSeparatorUnixThe (\ and /) separators will be replaced by /.fSeparator
fSeparatorWindowsThe (\ and /) separators will be replaced by \.fSeparator
fUnicodePathAllows you to specify the format of the function's result: the result will be in Unicode format.fShortPath
fLongPath
fListFile
fShortName
fLongName
fwAllEvent to monitor: Monitoring of all possible actions. Corresponds to fwCreateFile + fwModifyFile + fwRename + fwDeleteFile.fWatchFile,
fWatchDirectory
fwCreateFileEvent to monitor: Creation of a file or directory.fWatchFile,
fWatchDirectory
fwDeleteFileEvent to monitor: File or directory deletion.fWatchFile,
fWatchDirectory
fwModifyFileEvent to monitor: File or directory change.fWatchFile,
fWatchDirectory
fwRenameEvent to watch for: File or directory renaming.fWatchFile,
fWatchDirectory
ConstantDescriptionUsed by the functions
fAccessHandle the Date/Time of last file access.fDate, fTime
fcCopyUsed to continue the copy.fCopyFile
fCopyDir
fcIgnoreUsed to ignore the copy of a file.fCopyFile
fCopyDir
fCreationHandle the Date/Time of file creation.fDate, fTime
fcStopUsed to stop the copy permanently.fCopyFile
fCopyDir
fdCDRomDisc type: CD-ROM (and burners, DVD, etc.).fDriveInfo
fddDefaultThe data directory is automatically created if it does not exist.fDataDirCommon, fDataDirUser
fdDriveTypeType of information to be searched for: type of disc.fDriveInfo
fddWithoutCreationThe data directory is not created if it does not exist.fExtractPath
fDeleteDestinationIf the destination file already exists, it will be deleted then recreated.fMerge
fDeleteSource
  • The source file will be deleted as the split operation goes along.
  • The source files will be deleted as the merge operation goes along.
fSplit,
fMerge
fdFileNameSizeType of information to be searched for: maximum size of a file name on disk (in characters).fDriveInfo
fdFixedType of disk handled: fixed disk (hard disk).fDriveInfo
fdForbidVirtualFolderThe virtual directories are not listed.fSelectDir
fdFormerAspectAllows you to use the former directory picker (old style).fSelectDir
fdFreeSpaceType of information to be searched: disk space (in bytes).fDriveInfo
fdFullInformationReturns the entire information about the list of files and directories. fListFile,
fdIgnoreErrorIf a directory cannot be browsed, it is ignored.fDirSize
fdInterruptibleThe browse of the files/directories can be interrupted by pressing the ESC key.fListFile, fDirSize
fdInvalidType of disk handled: the path provided does not correspond to a disk.fDriveInfo
fDirectoryPortion of file path: different directories of the file (file name and extension are not returned).fExtractPath
fDirectoryPortion of file path: different directories of the file (file name and extension are not returned).fExtractPath
fdNbClusterType of information to be retrieved: number of disk clusters.fDriveInfo
fdNbSectorPerClusterType of information required: number of sectors per cluster.fDriveInfo
fdRAMType of disk handled: virtual disk.fDriveInfo
fdRemoteType of disk handled: network disk.fDriveInfo
fdRemovableDisk type: removable disk (floppy, zip, etc.).fDriveInfo
fDrivePortion of file path: unit name.fExtractPath
fdSectorSizeType of information to be searched: sector size (in bytes).fDriveInfo
fdSerialNumberType of information to search for: volume serial number.fDriveInfo
fdTotalSpaceType of information to be searched: total disk size (in bytes).fDriveInfo
fdUnknownUnknown type of disk.fDriveInfo
fdVolumeNameType of information to be searched for: volume name.fDriveInfo
fExtensionPortion of the file path: file extension, preceded by the ".".fExtractPath
fFilePortion of file path: file name (without extension).
Note: In previous versions, this constant was named fFileName.
fExtractPath
flChangeDirDirectory change: first file listed in a subdirectory.fListFile, fListDirectory, BurnerAddDirectory
flDirectorySame directory: listed file belonging to the same directory as the previous file.fListDirectory
flFileCharacteristics of listed file.fListFile, BurnerAddDirectory
flFirstFileThe listed file corresponds to the first directory file.fListFile, BurnerAddDirectory
fLinkPhysicalCreate a physical link.
A physical link is a file that can be accessed via several paths. The file deletion can be performed only when all physical links have been deleted.
fCreateLink
fLinkSymbolicCreate a symbolic link.
A symbolic link is a "pointer" to a file. The deletion of the symbolic link does not affect the pointed file. The deletion of the pointed file makes the symbolic link invalid.
fCreateLink
fLockEmptyFileUsed to lock a file, even if it is empty.<DiskFile variable>.Lock
fModifyHandle the Date/Time of last file modification.fDate, fTime
foAddFile opening mode: open file in "add" mode.fOpen
foAnsiUsed to manage an Ansi file when the "Use the Unicode strings at runtime" mode is enabled in the project configuration.
Mode used by default:
  • in the WINDEV and WEBDEV projects earlier than version 17,
  • in the configurations of WINDEV and WEBDEV projects that use the "Use Ansi strings at runtime" mode from version 17.
fLoadText,
fCreate,
fOpen,
fOpenTempFile
foAutomaticDeletionThe file will be automatically deleted when it is closed (with <DiskFile variable>.Close or when the application is closed). If multiple applications are using the file, it will be automatically deleted when the last application closes it (when <DiskFile variable>.Close is called, or at the end of the application).fCreate, fOpen, fOpenTempFile
foCreateFile opening mode: file creation.fOpen
foCreateIfNotFoundFile open mode: file creation only if file does not exist.fOpen
foReadFile access mode: open file in "read-only" mode.fOpen
foReadLockBlock file opening: file created read-only. The other applications cannot read the current file.fCreate, fOpen, fOpenTempFile
foReadWriteFile access mode: open file in "read/write" mode.fOpen
foSequentialAccessOptimizes the management of caches for the file by specifying to Windows that the file will be read from the beginning to the end.fOpen
foUnicodeUsed to manage a Unicode file when the "Use the Ansi strings at runtime" mode is enabled in the project configuration.
Mode used by default:
  • in the WINDEV Mobile projects regardless of the mode and version used,
  • in the configurations of WINDEV and WEBDEV projects that use the "Use Unicode strings at runtime" mode from version 17.
fLoadText,fCreate,
fOpen,
foWithoutDeletionThe file will not be automatically deleted when it is closed.fOpenTempFile
foWriteFile access mode: open file in "write-only" mode.fOpen
foWriteLockLock when file is opened: file created in write-only mode. The other applications cannot modify the current file.fCreate, fOpen, fOpenTempFile
fpBeginningOriginal position in the file: first byte of the file.<DiskFile variable>.Seek (Function)
fpCurrentOriginal position in file: current position.<DiskFile variable>.Seek (Function)
fpEndOriginal position in the file: last byte of the file.<DiskFile variable>.Seek (Function)
frConfirmA confirmation is requested before overwriting a file or a directory (copy, move, etc.).fCopyFile, fCopyDir, fMoveDir
frDirectoryFind a directoryfDir
frelAllRelative path construction mode: Allows you to completely relativize the file path.fBuildRelativePath
fRelativePathUsed to return the parent directory in the format of a relative path.fParentDir
frelSubdirectoryOnlyRelative path construction mode: Relates the path to the parameter. <Chemin de reférence>. fBuildRelativePath
frFileFind a file.fDir
frNoHiddenDirectoryIf the frFullInformation constant is used, the hidden directories are not listed (attribute = "H").fListFile
frNoHiddenFileIf the frFullInformation constant is used, the hidden files are not listed (attribute = "H").fListFile
frNotRecursiveThe sub-directories are not processed.fListFile, fDirSize, <Variable Drive>.filelist, <Variable gglDrive>.retrieveGgl file
frProgressDisplays a progress window (progress bar)fCopyFile, fCopyDir, fMoveDir
frReadOnlyAlso deletes the read-only files. If this constant is not specified, the function will return False if read-only files must be deleted.fRemoveDir, fDelete
frRecursiveSubdirectories are processedfCopyFile, fListFile, fCopyDir, fMoveDir, fRemoveDir, <Variable Drive>.filelist, <Variable gglDrive>.retrieveGgl file
frToRecycleBinSends the file or the directory to the recycle bin of Windows instead of deleting it.fRemoveDir, fDelete
fselChangeSends the MessageSelect message to the calling WINDEV window whenever a click is performed on a file found in the file picker.fSelect
fselCreateOpens the file picker in creation mode ("Save" button).fSelect
fselExistOpening mode of the file picker:
  • with fselCrée: Returns the name of the selected file. If the file already exists, a dialog box displays and allows the user to overwrite the former file,
  • with fselOuvre Returns the name of the selected file only if it exists.
fSelect
fselMultiOpens the file picker in multi-selection mode. The user can select several files by pressing the "Ctrl" and "Shift" keys.
fselOpenOpens the file picker in opening mode ("Open" button).fSelect
fSeparatorPlatformThe separators (\ and /) will be replaced with the separator corresponding to the current platform.fSeparator
fSeparatorUnixThe (\ and /) separators will be replaced by /.fSeparator
fSeparatorWindowsThe (\ and /) separators will be replaced by \.fSeparator
fUnicodePathAllows you to specify the format of the function's result: the result will be in Unicode format.fShortPath
fLongPath
fListFile
fShortName
fLongName
fwAllEvent to monitor: Monitoring of all possible actions. Corresponds to fwCreateFile + fwModifyFile + fwRename + fwDeleteFile.fWatchFile,
fWatchDirectory
fwCreateFileEvent to monitor: Creation of a file or directory.fWatchFile,
fWatchDirectory
fwDeleteFileEvent to monitor: File or directory deletion.fWatchFile,
fWatchDirectory
fwModifyFileEvent to monitor: File or directory change.fWatchFile,
fWatchDirectory
fwRenameEvent to watch for: File or directory renaming.fWatchFile,
fWatchDirectory
Minimum version required
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 03/25/2025

Send a report | Local help