PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
ConstantAffectsUsed by the functions
fAccessHandle the Date/Time of last file access.fDate, fTime
Versions 19 and later
fcCopy
New in version 19
fcCopy
fcCopy
Used to continue the copy.fCopyFile
fCopyDir
Versions 19 and later
fcIgnore
New in version 19
fcIgnore
fcIgnore
Used to ignore the copy of a file.fCopyFile
fCopyDir
fCreationHandle the Date/Time of file creation.fDate, fTime
Versions 19 and later
fcStop
New in version 19
fcStop
fcStop
Used to stop the copy permanently.fCopyFile
fCopyDir
fdCDRomType of disk: 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.
Versions 19 and later
fDeleteDestination
New in version 19
fDeleteDestination
fDeleteDestination
If the destination file already exists, it will be deleted then re-created.
Versions 19 and later
fMerge
New in version 19
fMerge
fMerge
Versions 19 and later
fDeleteSource
New in version 19
fDeleteSource
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.
Versions 19 and later
fSplit,
fMerge
New in version 19
fSplit,
fMerge
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
Versions 18 and later
fdForbidVirtualFolder
New in version 18
fdForbidVirtualFolder
fdForbidVirtualFolder
The virtual directories are not listed.fSelectDir
Versions 23 and later
fdFormerAspect
New in version 23
fdFormerAspect
fdFormerAspect
Allows 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 + <Date of Last Modification> + 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 file path: different directories of the file (the name and extension of the file 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 disk: removable disk (diskette, zip, etc.).fDriveInfo
fDriveSection of 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 file path: file extension, preceded by ".".fExtractPath
fFileNameSection of file path: file name (without extension).fExtractPath
flChangeDirChange of directory: first file listed in a sub-directory.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
Versions 15 and later
fLinkPhysical
New in version 15
fLinkPhysical
fLinkPhysical
Create 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
Versions 15 and later
fLinkSymbolic
New in version 15
fLinkSymbolic
fLinkSymbolic
Create 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
Versions 17 and later
foAnsi
New in version 17
foAnsi
foAnsi
Used to manage an Ansi file when the "Use the Unicode strings at run time" 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 the Ansi strings at run time" mode from version 17.
fLoadText,
fCreate,
fOpen,
fOpenTempFile
foAutomaticDeletionThe file will be automatically deleted when it is closed (call to fClose or at the end of application). If this file is opened by several applications, the file will be automatically deleted when the last application closes the file (call to fClose or at the end of application).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
Versions 19 and later
foSequentialAccess
New in version 19
foSequentialAccess
foSequentialAccess
Optimizes 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 run time" 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 the Unicode strings at run time" mode from version 17.
Versions 17 and later
fLoadText,
New in version 17
fLoadText,
fLoadText,fCreate,
Versions 17 and later
fOpen,
New in version 17
fOpen,
fOpen,
Versions 17 and later
fOpenTempFile
New in version 17
fOpenTempFile
fOpenTempFile
foWithoutDeletionThe file will not be automatically erased 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
Versions 15 and later
fPathUNICODE
New in version 15
fPathUNICODE
fPathUNICODE
Used 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
Versions 15 and later
fRelativePath
New in version 15
fRelativePath
fRelativePath
Used to return the parent directory in the format of a relative path.fParentDir
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
frRecursiveThe sub-directories 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 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
Versions 15 and later
fSeparatorPlatform
New in version 15
fSeparatorPlatform
fSeparatorPlatform
The separators (\ and /) will be replaced by the separator corresponding to the current platform.fSeparator
Versions 15 and later
fSeparatorUnix
New in version 15
fSeparatorUnix
fSeparatorUnix
The separators (\ and /) will be replaced by the / separator /.fSeparator
Versions 15 and later
fSeparatorWindows
New in version 15
fSeparatorWindows
fSeparatorWindows
The separators (\ and /) will be replaced by the \ separator \.fSeparator
Versions 18 and later
ftAll
New in version 18
ftAll
ftAll
Event to track: All the possible actions will be tracked. Corresponds to ftCreateFile + ftModifyFile + ftRename + ftDeleteFile.
Versions 18 and later
fTrackFile,
fTrackDirectory
New in version 18
fTrackFile,
fTrackDirectory
fTrackFile,
fTrackDirectory
Versions 18 and later
ftCreateFile
New in version 18
ftCreateFile
ftCreateFile
Event to track: Creating a file or a directory.
Versions 18 and later
fTrackFile,
fTrackDirectory
New in version 18
fTrackFile,
fTrackDirectory
fTrackFile,
fTrackDirectory
Versions 18 and later
ftDeleteFile
New in version 18
ftDeleteFile
ftDeleteFile
Event to track: Deleting a file or a directory.
Versions 18 and later
fTrackFile,
fTrackDirectory
New in version 18
fTrackFile,
fTrackDirectory
fTrackFile,
fTrackDirectory
Versions 18 and later
ftModifyFile
New in version 18
ftModifyFile
ftModifyFile
Event to track: Changing a file or a directory.
Versions 18 and later
fTrackFile,
fTrackDirectory
New in version 18
fTrackFile,
fTrackDirectory
fTrackFile,
fTrackDirectory
Versions 18 and later
ftRename
New in version 18
ftRename
ftRename
Event to track: Renaming a file or a directory.
Versions 18 and later
fTrackFile,
fTrackDirectory
New in version 18
fTrackFile,
fTrackDirectory
fTrackFile,
fTrackDirectory
Minimum required version
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment