ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / WLanguage / WLanguage functions / Standard functions / External file functions
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
Display constants used by prefix syntaxes only
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
fdCDRomType of drive: CD-ROM (and burners, DVD, etc.).fDriveInfo
fddDefaultThe data directory is automatically created if it does not exist.fDataDirCommon, fDataDirUser
fdDriveTypeType of information to retrieve: type of disk.fDriveInfo
fddWithoutCreationThe data directory is not created if it does not exist.fExtractPath
fDeleteDestinationIf the destination file already exists, it will be deleted then re-created.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 retrieve: maximum size of file name on disk (in characters).fDriveInfo
fdFixedType of disk used: hard drive (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 retrieve: available disk space (in bytes).fDriveInfo
fdFullInformationReturns the entire information about the list of files and directories. Each line (separated by CR characters) contains the following information:
<Full file name> + TAB + <Size in bytes> + TAB + <Last modified> + TAB + <File attributes>
The date is in YYYYMMDDHHmmSS format. The attributes are identical to the ones returned by fAttribute.
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 used: the specified path does not correspond to a disk.fDriveInfo
fDirectorySection of the file path: different file directories (the file name and extension are not returned).fExtractPath
fDirectorySection of the file path: different file directories (the file name and extension are not returned).fExtractPath
fdNbClusterType of information to retrieve: number of disk clusters.fDriveInfo
fdNbSectorPerClusterType of information to retrieve: number of sectors per cluster.fDriveInfo
fdRAMType of disk used: virtual disk.fDriveInfo
fdRemoteType of disk used: network disk.fDriveInfo
fdRemovableType of drive: removable disk (diskette, zip, etc.).fDriveInfo
fDriveSection of the file path: name of unit.fExtractPath
fdSectorSizeType of information to retrieve: size of sector (in bytes).fDriveInfo
fdSerialNumberType of information to retrieve: serial number of volume.fDriveInfo
fdTotalSpaceType of information to retrieve: total size of the disk (in bytes).fDriveInfo
fdUnknownUnknown type of disk.fDriveInfo
fdVolumeNameType of information to retrieve: name of volume.fDriveInfo
fExtensionSection of the file path: file extension, preceded by ".".fExtractPath
fFileSection of the file path: file name (without extension).
Remark: This constant corresponds to fFileName in previous versions.
fExtractPath
flChangeDirChanges the directory: 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
foAddOpening mode of file: open the 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
foCreateOpening mode of file: create the file.fOpen
foCreateIfNotExistOpening mode of file: create the file only if this file does not exist.fOpen
foReadAccess mode to the file: open the file in "read-only" mode.fOpen
foReadLockLock when opening the file: file created in read-only. The other applications cannot read the current file.fCreate, fOpen, fOpenTempFile
foReadWriteAccess mode to the file: open the 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
foWriteAccess mode to the file: open the file in "write-only" mode.fOpen
foWriteLockLock when opening the file: file created in write-only. The other applications cannot modify the current file.fCreate, fOpen, fOpenTempFile
fPathUNICODEUsed to specify the format of function result: the result will be in Unicode format.fShortPath
fLongPath
fListFile
fShortName
fLongName
fpBeginningSource position in the file: first file byte.fSeek
fpCurrentSource position in the file: current position.fSeek
fpEndSource position in the file: last file byte.fSeek
frConfirmA confirmation is requested before overwriting a file or a directory (copy, move, etc.).fCopyFile, fCopyDir, fMoveDir
frDirectoryFind a directoryfDir
frelAllMode for building the relative path: Gets the relative path of the file.fBuildRelativePath
fRelativePathUsed to return the parent directory in the format of a relative path.fParentDir
frelSubdirectoryOnlyMode for building the relative path: Gets the path relative to the <Reference path>. 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
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
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 fselCreate: 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 fselOpen: Returns the name of the selected file if this file 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
ftAllEvent to track: All the possible actions will be tracked. Corresponds to ftCreateFile + ftModifyFile + ftRename + ftDeleteFile.fTrackFile,
fTrackDirectory
ftCreateFileEvent to track: Creating a file or a directory.fTrackFile,
fTrackDirectory
ftDeleteFileEvent to track: Deleting a file or a directory.fTrackFile,
fTrackDirectory
ftModifyFileEvent to track: Changing a file or a directory.fTrackFile,
fTrackDirectory
ftRenameEvent to track: Renaming a file or a directory.fTrackFile,
fTrackDirectory
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
fdCDRomType of drive: CD-ROM (and burners, DVD, etc.).fDriveInfo
fddDefaultThe data directory is automatically created if it does not exist.fDataDirCommon, fDataDirUser
fdDriveTypeType of information to retrieve: type of disk.fDriveInfo
fddWithoutCreationThe data directory is not created if it does not exist.fExtractPath
fDeleteDestinationIf the destination file already exists, it will be deleted then re-created.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 retrieve: maximum size of file name on disk (in characters).fDriveInfo
fdFixedType of disk used: hard drive (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 retrieve: available disk space (in bytes).fDriveInfo
fdFullInformationReturns the entire information about the list of files and directories. Each line (separated by CR characters) contains the following information:
<Full file name> + TAB + <Size in bytes> + TAB + <Last modified> + TAB + <File attributes>
The date is in YYYYMMDDHHmmSS format. The attributes are identical to the ones returned by fAttribute.
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 used: the specified path does not correspond to a disk.fDriveInfo
fDirectorySection of the file path: different file directories (the file name and extension are not returned).fExtractPath
fDirectorySection of the file path: different file directories (the file name and extension are not returned).fExtractPath
fdNbClusterType of information to retrieve: number of disk clusters.fDriveInfo
fdNbSectorPerClusterType of information to retrieve: number of sectors per cluster.fDriveInfo
fdRAMType of disk used: virtual disk.fDriveInfo
fdRemoteType of disk used: network disk.fDriveInfo
fdRemovableType of drive: removable disk (diskette, zip, etc.).fDriveInfo
fDriveSection of the file path: name of unit.fExtractPath
fdSectorSizeType of information to retrieve: size of sector (in bytes).fDriveInfo
fdSerialNumberType of information to retrieve: serial number of volume.fDriveInfo
fdTotalSpaceType of information to retrieve: total size of the disk (in bytes).fDriveInfo
fdUnknownUnknown type of disk.fDriveInfo
fdVolumeNameType of information to retrieve: name of volume.fDriveInfo
fExtensionSection of the file path: file extension, preceded by ".".fExtractPath
fFileSection of the file path: file name (without extension).
Remark: This constant corresponds to fFileName in previous versions.
fExtractPath
flChangeDirChanges the directory: 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
foAddOpening mode of file: open the 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
foCreateOpening mode of file: create the file.fOpen
foCreateIfNotExistOpening mode of file: create the file only if this file does not exist.fOpen
foReadAccess mode to the file: open the file in "read-only" mode.fOpen
foReadLockLock when opening the file: file created in read-only. The other applications cannot read the current file.fCreate, fOpen, fOpenTempFile
foReadWriteAccess mode to the file: open the 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
foWriteAccess mode to the file: open the file in "write-only" mode.fOpen
foWriteLockLock when opening the file: file created in write-only. The other applications cannot modify the current file.fCreate, fOpen, fOpenTempFile
fPathUNICODEUsed to specify the format of function result: the result will be in Unicode format.fShortPath
fLongPath
fListFile
fShortName
fLongName
fpBeginningSource position in the file: first file byte.<DiskFile variable>.Seek (Function)
fpCurrentSource position in the file: current position.<DiskFile variable>.Seek (Function)
fpEndSource position in the file: last file byte.<DiskFile variable>.Seek (Function)
frConfirmA confirmation is requested before overwriting a file or a directory (copy, move, etc.).fCopyFile, fCopyDir, fMoveDir
frDirectoryFind a directoryfDir
frelAllMode for building the relative path: Gets the relative path of the file.fBuildRelativePath
fRelativePathUsed to return the parent directory in the format of a relative path.fParentDir
frelSubdirectoryOnlyMode for building the relative path: Gets the path relative to the <Reference path>. 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
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
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 fselCreate: 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 fselOpen: Returns the name of the selected file if this file 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
ftAllEvent to track: All the possible actions will be tracked. Corresponds to ftCreateFile + ftModifyFile + ftRename + ftDeleteFile.fTrackFile,
fTrackDirectory
ftCreateFileEvent to track: Creating a file or a directory.fTrackFile,
fTrackDirectory
ftDeleteFileEvent to track: Deleting a file or a directory.fTrackFile,
fTrackDirectory
ftModifyFileEvent to track: Changing a file or a directory.fTrackFile,
fTrackDirectory
ftRenameEvent to track: Renaming a file or a directory.fTrackFile,
fTrackDirectory
Minimum version required
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 01/12/2023

Send a report | Local help