ONLINE HELP
 WINDEV, WEBDEV AND WINDEV MOBILE

Version: 2026
"END:" label
The END: label is used to define a code that will be systematically run at the end of process execution.
LogBackupDirectory (Property)
The LogBackupDirectory property is used to manage the backup directory of log files.
HChangeRplDir (Function)
Changes the location of the subscriber replica description ("*.rpl" file).
HSubstDir (Function)
Associates the data directory specified in the analysis with a directory found on disk.
fSplit (Function)
Splits a file into several files.
zipNbFile (Function)
Returns the number of files found in an archive (in CAB, RAR, ZIP, WDZ or 7z format).
fMerge (Function)
Merges several files into a single one.
ServiceWait (Function)
Pauses the current service during the specified duration.
Starting WDOptimizer in a command line
NextTitle (Function)
Modifies the title of next window to open.
HListTrigger (Function)
Returns the list of triggers applied to one or more HFSQL data files.
<zipArchive variable>.ListFile (Function)
Returns the list of files found in an archive.
Configuring the Apache 2.2 server
WEBDEV Development: Configuring the Apache 1.3.x and 2.0.x servers for the CGI protocol and WEBDEV sites.
hScheduledOptimization (Variable type)
The hScheduledOptimization type is used to programmatically manage a scheduled optimization task on an HFSQL server.
DnDCacheData (Function)
Indicates the type of data and the data to copy/move during Drag/Drop.
BurnerAddFile (Function)
Adds a file to the compilation.
<Upload>.Start (Function)
Starts sending the selected files into an Upload control.
UploadStart (Function)
Starts sending the selected files into an Upload control.
HChangeLogDir (Function)
Modifies the location of log files corresponding to an HFSQL data file.
<Source>.ChangeLogDir (Function)
Modifies the location of log files corresponding to an HFSQL data file.
<Word Processing>.Save (Function)
Saves a document as a "docx" file.
fListResource (Function)
Lists the resources integrated to the application.
HTransactionCancel (Function)
If a transaction is active, rolls back all changes made to the data files since the beginning of the transaction.
hScheduling (Variable type)
The hScheduling type is used to define and find out the characteristics of the scheduling that must be performed:
  • for a scheduled HFSQL Client/Server data file optimization task.
  • for a scheduled HFSQL Client/Server data file backup job.
  • for a scheduled replication of HFSQL servers.
fCopyDir (Function)
Copies the contents of a directory and its subdirectories.
DocSave (Function)
Saves a document as a "docx" file.
MCIVolume (Function)
Modifies or returns the sound volume.
Upload control events
The WLanguage events associated with the Upload control are as follows:
<Document variable>.Save (Function)
Saves a document as a "docx" file.
ScanWithUserInterface (Function)
Saves a document from a scanner to one or more files, using the scanner's user interface.
<Scanner variable>.WithUserInterface (Function)
Saves a document from a scanner to one or more files, using the scanner's user interface.
HModifyStructure (Example)
Usage example of the HModifyStructure function
BurnerAddDirectory (Function)
Adds all the files found in a directory to the compilation.
iParameterExport (Function)
Allows you to configure the exports performed from the report viewer:
  • parameters for sending emails.
  • parameters for creating the different files.
fListFile (Function)
Lists the files found in a directory and returns the list of files.
JavaLoad (Function)
Specifies the location of user classes required to run the Java application or the Java applet.
fDataDir (Function)
Returns the full path of the directory of HFSQL data files specified by the user when installing the application.
<Source>.ActivateAutoFilter (Function)
Enables an automatic filter on the linked files when browsing an XML file.
<Connection variable>.InfoLock (Function)
Returns information about the lock set on a data file, on one or all the records in a data file.
<Source>.ChangeLocation (Function)
Modifies the search mode of physical data files (.FIC, .NDX, ...).
HSubstDir (Example)
Usage example of the HSubstDir function
OBEXListFile (Function)
Lists the files shared by a device that uses the OBEX protocol.
HActivateAutoFilter (Function)
Enables an automatic filter on the linked files when browsing an XML file.
HChangeLocation (Function)
Modifies the search mode of physical data files (.FIC, .NDX, ...).
HClose (Function)
Closes either a data file or all data files opened by the current user: all corresponding physical data files are closed for the current user.
<zipArchive variable>.CurrentFile (Function)
Returns the name of the archived file currently handled by the functions for adding and extracting files.
<Upload>.FileName (Function)
Returns the name of a file "uploaded" by the Web user. This file must have been uploaded:
  • via an "Upload" edit control.
  • via a single-file or multi-file Upload field.
BurnerMediaType (Function)
Used to find out and modify the format of the CD or DVD to burn.
HashFile (Function)
Calculates the Hash of a file according to a specific algorithm.
<Dashboard>.LoadConfiguration (Function)
Restores the configuration of a Dashboard control.
zipExtractAll (Function)
Extracts all files from an archive and decompresses them.
gpwOpenLDAPSession (Function)
Informs the User Groupware that the authentication of users will be done via an LDAP directory.
Menus and menu options: Tips & Tricks
This page presents some operations specific to the menus and to the menu options...
DashLoadConfiguration (Function)
Restores the configuration of a Dashboard control.
fSelect (Example)
Usage example of the fSelect function
Playing a video with the MCI functions
MCI functions are used to easily handle the media files...
MyParent (Reserved word)
MyParent is used to handle...
WDModFic: Tool for automatic modification of data files
WDModFic is a tool for automated modification of data files on development and end-user workstations...
WithSpace (Function)
Adds or deletes the spaces found on the right of a text item when reading it.
zipDeleteAll (Function)
Deletes all files from an archive.
<Word Processing>.Add (Function)
Adds an element, document, paragraph, text, image or fragment at the end of a Word Processing control.
zipCurrentFile (Function)
Returns the name of the archived file currently handled by the functions for adding and extracting files.
HOnError (Function)
Customizes the management of HFSQL errors.
<Document variable>.Add (Function)
Adds an element, document, paragraph, text, image or fragment at the end of a Document variable.
<zipArchive variable>.DeleteAll (Function)
Deletes all files from an archive.
docElementImage (Variable type)
The docElementImage type is used to handle the characteristics of an Image element found in a docElement variable.
Writing an email
Writing an email in WLanguage consists in filling the email structure of WLanguage...
zipArchivedFile (Variable type)
The zipArchivedFile type is used to handle:
  • a file contained in an archive corresponding to one of the following formats: ZIP, CAB, RAR, WDZ, 7z, TAR, gzip or TGZ (TAR.GZ).
  • a file to add into an archive.
<Word Processing>.Insert (Function)
Inserts an object in a Word Processing control. The objects that can be used are:
  • an element,
  • a document,
  • a paragraph,
  • a text,
  • an image,
  • a fragment.
<Document variable>.Insert (Function)
Inserts an object in a Document variable. The objects that can be used are:
  • an element,
  • a document,
  • a paragraph,
  • a text,
  • an image,
  • a fragment.
NetworkConnect (Function)
Associates a drive with a shared network directory.
HInfoLock (Function)
Returns information about the lock set on a data file, on one or all the records in a data file.
WLanguage procedure called by zipAddDirectory
WLanguage procedure ("Callback") called when adding files with zipAddDirectory.
XMLSave (Function)
Saves an XML document in a file.
Handling HTML text in an Edit control
WEBDEV allows you to manipulate text in HTML via the "HTML format" option of the Edit controls and the HTML control.
<zipArchive variable>.ExtractDirectory (Function)
Automatically extracts and decompresses files from a directory in the file tree of an archive to a physical location.
fCompare (Function)
Compares the content of two files bit by bit.
<xmlDocument variable>.Save (Function)
Saves an XML document in a file.
Charset (Property)
The Charset property is used to:
  • Get the character set used by a Font variable.
  • Change the character set used by a Font variable.
  • Get the character set used by an HFSQL data file.
BurnerErase (Function)
Erases the files found on a rewritable CD or DVD.
<Source>.Mode (Function)
Changes the mode and the method for locking data files.
WLanguage procedure called by fCopyDir
WLanguage procedure ("callback") called by fCopyDir for each copied file. This procedure is used to handle the current file.
HMode (Function)
Changes the mode and the method for locking data files.
HDescribeTrigger (Function)
Adds or modifies a trigger on an HFSQL data file.
HOpen (Function)
Opens a data file.
DocAdd (Function)
Adds:
  • at the end of a word processing document: an element, document, paragraph, text, image or fragment.
  • at the end of a fragment: an element, text or image.
UploadFileName (Function)
Returns the name of a file "uploaded" by the Web user. This file must have been uploaded:
  • via an "Upload" edit control.
  • via a single-file or multi-file Upload field.
fCopyFile (Function)
Copies one or more files (regardless of their attributes).
HSetIntegrity (Function)
Enables or disables the management of an integrity constraint on a file link.
Designing a supercontrol
A supercontrol is an advanced type of control...
DocInsert (Function)
Inserts an object into a Word Processing document or replaces the content of the current fragment. The objects that can be used are:
  • an element,
  • a document,
  • a paragraph,
  • a text,
  • an image,
  • a fragment.
Associative array (Variable type)
An associative array is an "advanced" type of array...
zipExtractDirectory (Function)
Automatically extracts and decompresses files from a directory in the file tree of an archive to a physical location.
Handling RTF in an Edit control
Rich Text Format (RTF) is used to encode text and simplify exchange between applications...
Connection (Variable type)
The Connection type is used to describe one or more connections to external databases (HFSQL Client/Server, Native Connector, etc, ...
zipArchive (Variable type)
The zipArchive type is used to handle archive files in the following formats: ZIP, CAB, RAR, WDZ, 7z, TAR, gzip or TGZ (TAR.GZ).
External language: Pascal programming
We are going to call the elements developed in WINDEV (project, windows, ...
NameBrowserFile (Property)
The NameBrowserFile property gets the original name of the file to upload from the user's computer.
<zipArchive variable>.ExtractAll (Function)
Extracts all files from an archive and decompresses them.
Replication of HFSQL servers (Programming)
To implement a replication of HFSQL servers through programming, WLanguage...
Automatic data masking
Data masking is a process that transforms the data in an item that will be displayed to the user...
NameServerFile (Property)
The NameServerFile property is used to get the name of the uploaded file on the server.
Downloading files
The download is the operation that consists in saving a file stored on the server onto the computer of Web user...
zipAddDirectory (Function)
Adds all the files found in a directory and in its subdirectories into an archive and compresses them.
AAFImportParameter (Function)
Loads all customizations made via AAFs (Automatic Applications Features) that have previously been saved to a file.
AAFExportParameter (Function)
Saves all customizations made via AAFs (Automatic Application Features) in a file.
ExplorerRetrieve (Function)
Retrieves the number and the name of the files "dropped" from the explorer.
Error handling WLanguage procedure called by zipExtractDirectory
WLanguage procedure ("Callback") called if an error is encountered when extracting files with zipExtractDirectory.
WLanguage procedure called by zipAddDirectory to handle the progress bar
WLanguage procedure ("Callback") used by zipAddDirectory to manage the progress of files being added to the archive.
HCreationIfNotFound (Function)
Performs the following operations:
  • If the data file doesn't exist, create an empty data file (file with ".FIC" extension) with the index file, the full-text index file and the memo file if necessary. The function is equivalent to HCreation.
  • If the data file exists, opens the data file.
BurnerVolumeName (Function)
Allows you to find out or modify the name of the CD or DVD to burn.
1
…
5