ONLINE HELP
 WINDEV, WEBDEV AND WINDEV MOBILE

Version: 2026
OLEServer (Function)
Lists the OLE servers registered toward the current system.
TableSearch (Function)
Performs a search in:
  • a Table control,
  • a TreeView Table control,
  • tables displayed in a Combo Box control.
WDModFic: Tool for automatic modification of data files
WDModFic is a tool for automated modification of data files on development and end-user workstations...
TableSelectPlus (Function)
Selects a row in a Table or TreeView Table control.
TableSelectCount (Function)
Returns the number of selected elements in a Table or TreeView Table control (especially multi-selection controls).
TableSelect (Function)
Returns the index of the selected element in the Table or TreeView Table control.
JSProperty (Function)
Used to handle specific features on the objects found in the current page.
SchedulerDeleteTask (Function)
Deletes a scheduled task.
"END:" label
The END: label is used to define a code that will be systematically run at the end of process execution.
JavaExecute (Function)
Starts a Java application or a Java applet by invoking the "Main" method of a given Java class.
TableEnumColumn (Function)
Returns the name of a column found in a Table or Treeview Table control.
PositionOccurrence (Function)
Finds the Xth position of a string within another string.
InitWindow (Function)
Initializes (or not) the controls to zero and runs the initialization processes of the controls and the window.
MatchRegularExpression (Function)
Checks whether a character string matches a specific format and retrieves the different substrings that match the format.
MDIWindowMenu (Function)
Modifies the layout of the MDI child windows.
EmailReadLastHeader (Function)
Reads the header of the last Email received, depending on the protocol used (POP3 or IMAP, Lotus Notes or Outlook).
grAddData (Function)
Adds a data into a chart.
grGradient (Function)
Enables or disables the display of color gradients in a chart.
LooperBreakIndex (Function)
Returns the index of the break header and footer for a given break in a Looper control.
LDAPDeleteAttributeValue (Function)
Deletes a value of a specified attribute.
Proxy (Function)
Specifies whether the communication functions that use HTTP or HTTPS must go through a proxy to execute their requests. A proxy is used to share the access to Internet between the different network computers.
eRoundDifference (Function)
Returns the rounding difference between:
  • the value displayed in a "Currency + Euro" control,
  • the associated control used for dual display.
WinEnableDDW (Function)
Enables or disables the DDW (Dim Disabled Window) feature:
  • for a specific window.
  • for all the application windows.
WinInactiveEffect (Function)
Enables or disables the DDW (Dim Disabled Window) feature:
  • for a specific window.
  • for all the application windows.
NbThumbnail (Property)
The NbThumbnail property is used to get the number of thumbnails generated for an item.
NbDescribedThumbnail (Property)
The NbDescribedThumbnail property is used to get the number of thumbnails expected for an item.
HFilterIncludedBetween (Function)
Defines and enables an "Included between" filter on a file, view or query.
HFilterStartsWith (Function)
Defines and enables a "Start with" filter on a file, view or query.
HFilterIdentical (Function)
Defines and enables a filter used to find the exact value of a string item.
Programming a status bar
WINDEV allows you to manipulate a status Bar and a status Bar cell directly by programming...
HDeactivateAutoFilter (Function)
Disables an automatic filter on the linked files when browsing an XML file.
Events associated with TreeView controls
List of events associated with TreeView controls
DnDCacheData (Function)
Indicates the type of data and the data to copy/move during Drag/Drop.
EnumSubElement (Function)
Used to enumerate the subelements of a project element.
EnumElement (Function)
Enumerates project elements: windows, pages, reports, queries, etc.
HInfoLock (Function)
Returns information about the lock set on a data file, on one or all the records in a data file.
gLink (Function)
Adds an "invisible" value to an element of a List or Combo Box control.
Function kept for compatibility. It is recommended to use gStoredValue.
HActivateAutoFilter (Function)
Enables an automatic filter on the linked files when browsing an XML file.
HOnError (Function)
Customizes the management of HFSQL errors.
DDESend (Function)
Sends a data to the program connected via DDE.
fDataDir (Function)
Returns the full path of the directory of HFSQL data files specified by the user when installing the application.
fCopyDir (Function)
Copies the contents of a directory and its subdirectories.
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.
fListFile (Function)
Lists the files found in a directory and returns the list of files.
HViewToFile (Function)
Saves the modifications performed in an HFSQL view (by HModify, HDelete or HCross) in the corresponding data file. This function uses the former view mechanism.
SelectionOnly (Property)
The SelectionOnly property is used to:
  • Know which records in the Table or Hierarchical Table field are printed: print all records or only selected records.
  • Change the print mode for Table or TreeView Table control rows: print all records or selected records only.
SchedulerModifyTrigger (Function)
Modifies the parameters of a trigger of a scheduled task, i.e. the parameters that will define the execution of a task.
HSubstDir (Function)
Associates the data directory specified in the analysis with a directory found on disk.
Starting WDOptimizer in a command line
XMLFind (Function)
Performs a search in an XML document.
ExceptionChangeParameter (Function)
Configures the automatic behavior that will be implemented if an exception occurs in the current process.
JavaLoad (Function)
Specifies the location of user classes required to run the Java application or the Java applet.
LDAPListAttribute (Function)
Lists the object attributes in an LDAP server.
JavaExecuteFunction (Function)
Starts a specific static function of a given Java class.
iPageHeight (Function)
Calculates the height of printable page (in millimeters) while taking the top or bottom margins into account.
EmailReadPreviousHeader (Function)
Reads the header of the email found before the current email according to the protocol used (POP3 or IMAP, Lotus Notes or Outlook).
HListTrigger (Function)
Returns the list of triggers applied to one or more HFSQL data files.
Bitwise operators
The operations on binary values are performed...
EmailReadMessage (Example)
Usage example of the EmailReadMessage function
HFree (Function)
Transforms the crossed records (HCross) into deleted records.
Hour (Property)
The Hour property is used to:
  • Get the time from a variable of type Time or DateTime, or the number of hours from a variable of type Duration.
  • Change the time in a variable of type Time or DateTime, or the number of hours in a variable of type Duration.
  • Retrieve the time or the number of hours from a Date item (in "Date and time" or "Duration" format) or from a Time item.
  • Modify the time or the number of hours in a Date item (in "Date and time" or "Duration" format) or in a Time item.
SQLListSource (Function)
Lists the data sources declared on a local site.
Condensed (Property)
The Condensed property is used to:
  • Determine whether a Font variable is condensed.
  • Condense a Font variable.
This property is kept for backward compatibility.
HTransactionCancel (Function)
If a transaction is active, rolls back all changes made to the data files since the beginning of the transaction.
WithSpace (Function)
Adds or deletes the spaces found on the right of a text item when reading it.
Minute (Property)
The Minute property is used to:
  • Retrieve the minutes from a Time or DateTime variable, or the number of minutes from a Duration.
  • Change the minutes in a Time or DateTime variable, or the number of minutes in a Duration.
  • Retrieve the minutes or the number of minutes from a Date item (in "Date and Time" or "Duration" format) or from a Time item.
  • Modify the minutes or the number of minutes in a Date item (in "Date and Time" or "Duration" format) or in a Time item.
Use (Function)
Opens a WINDEV window and closes all other previously open windows.
Checked (Property)
The Checked property gets and sets the checkmark state of an element.
CtCursorOptions (Property)
The CtCursorOptions property gets the cursor type used when connecting to an external database.
CtExtendedInfo (Property)
The CtExtendedInfo property gets the additional information inserted into the database connection string.
Extended (Property)
The property Extended allows you to:
  • Find out whether a Font variable is extended.
  • Extend (or not) a Font variable.
This property is kept for backward compatibility.
Day (Property)
The Day property is used to:
  • Get the day from a Date or DateTime variable, or get the number of days from a Duration variable.
  • Change the day of a Date or DateTime variable, or change the number of days of a Duration variable.
  • Get the day or the number of days from a Date item (in "Date", "Date and Time" or "Duration" format)
  • Modify the day or the number of days in a Date item (in "Date", "Date and Time" or "Duration" format)
FontCondensed (Property)
The FontCondensed property is used to:
  • Determine if characters in a text are condensed.
  • Condense (or not) the characters in a text.
FontLarge (Property)
The FontLarge property is used to:
  • Determine if the text is expanded.
  • Expand the text.
Large (Property)
The Large property allows you to:
  • Find out whether a Font variable is enlarged.
  • Enlarge (or not) a Font variable.
This property is kept for backward compatibility.
Structure (Variable type)
A structure is a custom type of data...
Global and local variable
Two types of variables are available...
MCIVolume (Function)
Modifies or returns the sound volume.
Modified (Property)
The Modified property is used to determine if a control or group of controls has been modified by the user (keyboard or mouse input).
CreateShortcut (Function)
Creates a shortcut on the Windows desktop, in the "Start" menu of Windows or in a specific directory.
Multitask (Function)
MultiTask is used to:
  • define a timeout,
  • give control back to Windows,
  • give control back to Windows and to WLanguage.
Menus and menu options: Tips & Tricks
This page presents some operations specific to the menus and to the menu options...
DisplayedItem (Property)
The DisplayedItem property is used to:
  • Find out the item or the variable displayed by the control.
  • Modify the item or the variable displayed by the control.
CursorCapture (Function)
Directs all the events associated with the mouse toward a specific window or control, regardless of the screen object where the mouse event occurs.
dInvertColor (Function)
Reverses the colors:
  • in an Image control,
  • in an Image variable,
  • in a WDPic variable (on the background layer),
  • in a picLayer variable.
ListAdd (Function)
Adds an element to a List Box, ListView or Combo Box control populated programmatically.
Programming Table fields linked to a data file
Here are the main points of programming Table fields linked to a data file
Table field populated programmatically: handling in WLanguage
Here is an overview of how to manipulate Table controls populated programmatically in WLanguage.
Report based on a programmed data source
In a report on a programmed data source, the reading of the records that will be displayed in the report requires full programming in WLanguage...
Comparison operators
The comparison operators can be divided into several categories...
Report based on a memory area
A report based on a memory area is used to print the records stored in a memory area...
Report based on a query
Queries are used to easily select records in one or more data files...
MyParent (Reserved word)
MyParent is used to handle...
Designing a supercontrol
A supercontrol is an advanced type of control...
EmailNbMessage (Function)
Returns the number of incoming messages currently found:
  • on the email server (POP3 protocol only).
  • in the Outlook messaging software.
SQL selection conditions
To specify the selection conditions in an SQL query, you can use...
DisableAAF (Function)
Disables an Automatic Application Feature (AAF) on a control, window or on the current application.
LooperSearch (Function)
Searches for a value in an attribute of a Looper control.
CookieWrite (Function)
Writes a cookie onto the computer of the Web user.
ChangeSeparator (Function)
Changes the value of the separators (decimal separator or thousand separator) used in the numeric masks for internationalization.
ExecuteAAF (Function)
Runs an Automatic Application Feature (AAF) on a control or window.
Reading an email
This help page explains how to read an email from a WINDEV application and how to display its content in a WINDEV application.
BrowsedItem (Property)
The BrowsedItem property is used to:
  • Get the item used to automatically loop through Table, Looper, List Box, ListView and Combo Box controls, supercontrols and reports based on data files.
  • Change the item used to automatically loop through Table, Looper, List Box, ListView and Combo Box controls, supercontrols and reports based on data files. Then, the iteration is reinitialized.
fCopyFile (Function)
Copies one or more files (regardless of their attributes).
TableDelete (Function)
Deletes a row from:
  • a Table control,
  • a TreeView Table control,
  • a table displayed in a Combo Box control.
BrowserOpen (Function)
Opens a web page identified by its URL in a new browser.
ListDeleteAll (Function)
Clears a List Box, ListView or Combo Box control populated programmatically.
KeyPressed (Function)
Checks which key is pressed.
FinRepayVal (Function)
Returns the amount of each regular payment for an investment with fixed interest rate and fixed payment.
zipExtractAll (Function)
Extracts all files from an archive and decompresses them.
zipDeleteAll (Function)
Deletes all files from an archive.
TableDeleteAll (Function)
Deletes all rows from:
  • a Table control populated programmatically,
  • a TreeView Table control populated programmatically,
  • tables displayed in a Combo Box control.
HOpen (Function)
Opens a data file.
HReset (Function)
Initializes:
  • one or all variables of file items with their default values.
  • one or all items of a Record variable with their default values.
HSeekLast (Function)
Sets the position on the last file record whose value for a specific item is less than or equal to a sought value.
HSeekFirst (Function)
Positions on the first file record whose value for a specific item is greater than or equal to a sought value.
KeyType (Property)
The KeyType property is used to set the characteristics of a key item.
Note (Property)
The Note property is used to:
  • Find out the notes associated with a control, a window, a page or a report.
  • Modify the notes associated with a control, a window a page or a report.
HSynchronizeReplica (Function)
Synchronizes the master replica and the subscriber replica: the operations performed on one of the replica are transferred into the other replica.
StrikeOut (Property)
The StrikeOut property is used to:
  • Determine whether the strikethrough formatting is applied to a Font variable.
  • Apply strikethrough formatting to a Font variable.
HDeleteLink (Function)
Deletes an integrity rule between two data files on the server.
SQL functions: Special case
List of SQL functions: Special cases
The different types of browse available in SQL
Two types of browse can be used to browse the result of a query run by SQLExec...
gLinkActivate (Function)
Allows (or not) retrieving the value defined by gLink in a List Box or a Combo Box control.
Function kept for compatibility. It is recommended to use gStoredValueEnable.
HCheckStructure (Function)
Defines the mode for comparing data files.
HChangeLocation (Function)
Modifies the search mode of physical data files (.FIC, .NDX, ...).
HRplDeclareLink (Function)
Declares a (1, 1) (0, n) link between two tables.
HRplFilterProcedure (Function)
Defines the WLanguage procedure that will be called whenever a replication operation is performed on a specific file.
HChangeRplDir (Function)
Changes the location of the subscriber replica description ("*.rpl" file).
Reset (Function)
Reinitializes:
  • all the controls found in the current window or page (including the groups of controls, the supercontrols and the internal windows).
  • the controls found in a group of controls, a supercontrol, an internal window or an internal page.
HAlias (Function)
Creates a logical alias of a data file (or query) or cancels all existing aliases.
HChangeLogDir (Function)
Modifies the location of log files corresponding to an HFSQL data file.
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.
FileToMemoryList (Function)
Populates a List Box or Combo Box control programmatically with the records from a data file or query.
HListDatabase (Function)
Lists the Client/Server databases associated with a connection.
HDescribeTrigger (Function)
Adds or modifies a trigger on an HFSQL data file.
HRecordToXML (Function)
Retrieves the structure and the value of the current record and exports them into a character string in XML format.
VideoListDriver (Function)
Lists the video capture drivers installed on the current computer.
RTFSelection (Function)
Modifies or lists the attributes of the text currently selected in an RTF field (in a WINDEV window or report).
HExportXML (Function)
Exports the records found in a data file (HFSQL or OLE DB), view or query to an XML file.
HExecuteSQLQuery (Function)
Initializes a query written in SQL language and declares this query to the HFSQL engine.
HFilter (Function)
Defines and enables a filter on a data file, view or query.
Events associated with Looper controls
List of events associated with Looper controls
Table control events
List of events associated with Table controls
Data-bound report
A data-bound report is used to print the records coming from a single data file (HFSQL Classic or Client/Server, accessed via a Native Access, ...
SQLTable (Function)
Transfers the result of a query to a Table control populated programmatically (a List Box or Combo Box control), with the possibility of Partial Fetch (the result is retrieved by blocks of rows).
HSetIntegrity (Function)
Enables or disables the management of an integrity constraint on a file link.
HSetMemo (Function)
Used to modify the management mode of memo items.
SQLGetTextMemo (Function)
Retrieves the content of a Text Memo column found in the query result, for the current line.
SQLGetMemo (Function)
Retrieves the content of a Memo column from the query result, for the current row.
SQLGetCol (Function)
Retrieves the content of the specified column from the query result, for the current line.
HImportHF55 (Function)
Imports a Hyper File 5.5 file into an HFSQL Classic file.
Report based on a text file
In a report based on a text file, the information to print is read from a text file or is directly assigned in the report controls...
HImportText (Function)
Imports a Text file into an HFSQL Classic or Client/Server data file. This data file must have been defined in the data model editor, or declared with HDeclare, HDeclareExternal or HDescribeFile).
SQLExecWDR (Function)
Runs the SQL code of a query created in the query editor.
SQLExec (Function)
Names and runs an SQL query.
SQLConnect (Example)
Usage example of the SQLConnect function
SQLChangeConnection (Function)
Modifies the current connection.
Telephony: Managing incoming calls
The management of the incoming calls is performed in a specific "thread".
SQLLock (Function)
Used to lock:
  • The entire data table, in read and write mode. Its data cannot be accessed by other computers.
  • The records selected by the query. This data cannot be accessed by the other computers. This method can be used to update records for example.
SQLFetch (Function)
Goes to the next row (i.e next record) of the query result.
HListKey (Function)
Returns the list of keys in a data file (query or view) recognized by the HFSQL engine.
Native xBase/FoxPro Connector
WINDEV and WEBDEV offer a Native xBase/FoxPro Connector (or Native xBase/FoxPro Access) module...
HListLink (Function)
Returns the list of data file bindings (Merise type) present:
  • in the current analysis,
  • in ongoing analyses (projects with multiple analyses).
  • in a specific analysis.
HListREP (Function)
Returns the list of assignments for the data files handled by the current application, which means the list of physical files corresponding to the files described in the analysis.
HListItem (Function)
Returns the list of items:
  • found in a data file ( a query or a view) known to the HFSQL engine. The data files defined by HDeclare, HDeclareExternal and HDescribeFile are taken into account.
  • found in a Record variable.
Writing an email
Writing an email in WLanguage consists in filling the email structure of WLanguage...
HRead (Function)
Reads a record in a file according to a given record number.
HReadSeekLast (Function)
Sets the position on the last record whose value for a specific item is less than or equal to a sought value (exact-match search).
HMigrateLinkedCompositeKey (Function)
Migrates the values of the linked composite keys coming from a file in Hyper File 5.5 format to the HFSQL Classic format.
HMode (Function)
Changes the mode and the method for locking data files.
Managing emails with "Simple MAPI"
Simple MAPI simplifies the management of emails received by the hosting provider...
iImageHeight (Function)
Calculates the height of the image to print (in millimeters).
iPrintAreaRTF (Function)
Prints rich text format (RTF) in a rectangular area.
iImageWidth (Function)
Calculates the width of the image to print (in millimeters).
iPageWidth (Function)
Calculates the width (in millimeters) of the printable page while taking the left or right margins into account.
iMargin (Function)
Defines the "logical" print margins.
iParameterPreview (Function)
Configures the print preview:
  • display a message regarding the resources of current computer.
  • display or hide the ribbon tabs and buttons.
  • the export options available in the mini preview window.
iYPos (Function)
Used to manage the vertical position (Y-coordinate) of print cursor in the page.
grLabelFont (Function)
Modifies the font used for the category labels of a chart.
TreeExpandAll (Function)
Expands a node and all its child elements in a TreeView control.
AJAXCancelAsynchronousCall (Function)
Cancels the automatic execution of the browser procedure called by AJAXExecuteAsynchronous.
AJAXAsynchronousCallPending (Function)
Used to find out whether a server procedure called by AJAXExecuteAsynchronous is currently run.
AJAXAvailable (Function)
Used to find out whether the AJAX technology is supported by the current browser.
ChangeSourceWindow (Function)
Dynamically changes the window displayed in an Internal Window control.
Case of internal window dequeues Modifies the currently displayed window. This modification is saved in the list of internal windows to scroll.
Connection (Variable type)
The Connection type is used to describe one or more connections to external databases (HFSQL Client/Server, Native Connector, etc, ...
TreeListItem (Function)
Lists the "children" of a node and the "child" elements of these "children" in a TreeView control.
ThreadSendSignal (Function)
The current thread sends a signal to the specified thread in order to unlock it.
ThreadWaitSignal (Function)
Locks the current thread until it receives a signal from another thread.
DateTimeByDefault (Function)
Used to define the default value of Date, Time and DateTime variables.
WinRateDDW (Function)
Gets and sets the dimming rate for windows that use the DDW (Dim Disabled Windows) feature.
EventChange (Function)
Modifies the status of an event.
fListDirectory (Function)
Lists the subdirectories of a given directory and returns the full paths of listed subdirectories.
ExplorerRetrieve (Function)
Retrieves the number and the name of the files "dropped" from the explorer.
EventCreate (Function)
Creates an event.
Now (Function)
Returns or modifies the system time (current time defined for the current computer).
ImageInfoModify (Function)
Modifies the value of an Exif tag for the image used.
gr3DSParameter (Function)
Retrieves or modifies a parameter for drawing a chart in 3D Spatial mode.
LDAPReplaceAttribute (Function)
Replaces all the values of an attribute by a specific value.
grAxisTitleFont (Function)
Modifies the font used for the titles of the chart axes.
1
…
6
7
8