ONLINE HELP
 WINDEV, WEBDEV AND WINDEV MOBILE

Version: 2026
gpwOpenConfiguration (Function)
Opens the User Groupware configuration window or page.
External language: Pascal programming
We are going to call the elements developed in WINDEV (project, windows, ...
zipIsMulti (Function)
Returns the type of the archive: single-part archive or multi-part archive.
fSize (Function)
Returns the size of a file (in bytes).
fSelect (Example)
Usage example of the fSelect function
fWriteLine (Function)
Writes a line to a text file (ANSI or Unicode).
Properties associated with HTML Display controls
WINDEV and WINDEV Mobile include different WLanguage events associated with HTML Display Controls...
fReadLine (Function)
Reads a line from an external file (ANSI or Unicode).
<zipArchive variable>.ChangePath (Function)
Modifies the stored path of a file in an archive (in ZIP, WDZ or 7z format).
External language: Cobol programming
We are going to call the elements developed in WINDEV (project, windows, analysis, ...
ErrorChangeParameter (Function)
Configures the automatic behavior that will be implemented if an error occurs in the current process.
DomoSwitchOn (Function)
Switches on one or more electrical devices compatible with the X10 protocol.
ContactNext (Function)
Reads the contact after the current contact in a Lotus Notes or Outlook address book.
apExecute (Function)
Runs an action plan.
fSeek (Example)
Usage example of the fSeek function
EmailUpdate (Function)
Updates the messages of MS Exchange according to the email server.
ContactModify (Function)
Modifies the current contact in a Lotus Notes or Outlook address book.
AppointmentRead (Function)
Reads an appointment found in the calendar of a Lotus Notes or Outlook messaging.
DomoSwitchOff (Function)
Switches off one or more electrical devices compatible with the X10 protocol.
DomoOpen (Function)
Used to establish a connection with a X10 interface.
<EmailOutlookSession variable>.StartSession (Function)
Starts an Outlook section.
AppointmentFirst (Function)
Reads the first appointment in a Lotus Notes or Outlook calendar.
MCIExecute (Function)
Runs an MCI command (Media Control Interface).
fMemOpen (Function)
Opens a memory area shared between several applications.
EmailCopy (Function)
Copies an email found in a directory to another directory of an IMAP server.
zipChangePath (Function)
Modifies the stored path of a file in an archive (in ZIP, WDZ or 7z format).
zipOpenCAB (Function)
Opens an existing archive in CAB format.
<zipArchive variable>.NbPartNeeded (Function)
Returns the number of parts of a given size required to split a single-part archive.
HErrorPassword (Function)
After the execution of a read or write function in a data file, used to find out whether an error caused by a wrong password occurred on this data file.
AppointmentLast (Function)
Reads the last appointment in a Lotus Notes or Outlook calendar.
PicResize (Function)
Resizes a WDPic image.
fOpen (Function)
Opens an external file (ANSI or UNICODE) for programmatic manipulation.
<Window>.EnableDDW (Function)
Enables or disables the Dim Disabled Window (DDW) feature for a specific window:
AppointmentPrevious (Function)
Reads the appointment before the current appointment in a Lotus Notes or Outlook calendar.
WHelp (Function)
Displays a file or help page in CHM format.
<WDPic variable>.Resize (Function)
Resizes a WDPic image.
<DiskFile variable>.Size (Function)
Returns the size of a file (in bytes).
AppointmentNext (Function)
Reads the appointment after the current appointment in a Lotus Notes or Outlook calendar.
EmailStartOutlookSession (Function)
Allows you to access data handled by the Outlook messaging software (emails, contacts, groups of contacts, tasks, appointments and folders).
Sending and receiving emails
WINDEV, WEBDEV and WINDEV Mobile allow you to directly manage the emails from your applications...
<zipArchive>.SelectFile (Function)
Selects files from an archive.
Creating the Vision windows of the WINDEV RAD pattern
STOP (Reserved word)
STOP is used to call the WLanguage debugger during a test in the editor...
<emailOutlookSession variable>.RemoveFolder (Function)
Deletes a folder from the Outlook messaging software.
Shared memory areas
WINDEV, WEBDEV and WINDEV Mobile allow you to handle shared memory areas...
PicRotation (Function)
Rotates a WDPic image.
LabelNumberToStart (Property)
The LabelNumberToStart property is used to:
  • Find out the number of the label on the label sheet from which the print will be performed.
  • Modify the number of the label from which the print will be performed on the label sheet.
<DiskFile variable>.ReadLineRegularExpression (Function)
Reads a line in an external file, gets sections of this line according to a regular expression and assigns them to a variable.
NotesListItem (Function)
Returns the list of items for the current Notes document in Lotus Notes.
<emailOutlookSession variable>.CloseSession (Function)
Closes an Outlook session.
Creating the Table windows of the WINDEV RAD pattern
Creating the Table pages of the WEBDEV RAD pattern
Use (Function)
Opens a WINDEV window and closes all other previously open windows.
<WDPic variable>.Rotation (Function)
Rotates a WDPic image.
zipSelectFile (Function)
Selects files from an archive.
<emailNotesSession variable>.CloseSession (Function)
Closes a Notes session.
CertificateSignExecutable (Function)
Signs an executable file with a certificate.
<zipArchive variable>.Close (Function)
Closes an archive.
WinInactiveEffect (Function)
Enables or disables the DDW (Dim Disabled Window) feature:
  • for a specific window.
  • for all the application windows.
zipNbFile (Function)
Returns the number of files found in an archive (in CAB, RAR, ZIP, WDZ or 7z format).
sClose (Function)
Closes the specified serial port, parallel port or infrared port.
ErrorInfo (Function)
Retrieves information about the last error that occurred in a function of a WINDEV, WINDEV Mobile or WEBDEV component.
WinAnimationNext (Function)
Modifies the type and duration of animations used when opening and closing the next window.
<zipArchive variable>.IsMulti (Function)
Returns the type of the archive: single-part archive or multi-part archive.
"END:" label
The END: label is used to define a code that will be systematically run at the end of process execution.
<zipArchive variable>.ListFile (Function)
Returns the list of files found in an archive.
zipNbPartNeeded (Function)
Returns the number of parts of a given size required to split a single-part archive.
WinEnableDDW (Function)
Enables or disables the DDW (Dim Disabled Window) feature:
  • for a specific window.
  • for all the application windows.
ODBCConnectionName (Property)
The ODBCConnectionName property is used to:
  • Identify the name of the ODBC connection used when printing a report based on a "query performed on a connection".
  • Specify the name of the ODBC connection used when printing a report based on a "query performed on a connection".
<DiskFile variable>.ChangeSize (Function)
Resizes an external file.
zipClose (Function)
Closes an archive.
CertificateSignString (Function)
Creates the signature of a character string.
ODBCUserName (Property)
The property ODBCUsername property property allows you to:
  • Identify the username used to connect to a database via an ODBC driver or a Native Connector.
  • Specify the username used to connect to a database via an ODBC driver or a Native Connector.
ODBCSQLCode (Property)
The ODBCCodeSQL property property allows you to:
  • Find out the SQL code of the "query performed on a connection" (data source of report).
  • Modify the SQL code of the "query performed on a connection" (data source of report).
ODBCPassword (Property)
The ODBCPassword property is used to:
  • Identify the password used to connect to a database via an ODBC driver or a Native Connector.
  • Specify the password used to connect to a database via an ODBC driver or a Native Connector.
HInfoFileProperty (Function)
Gets the properties of a data file located in an HFSQL server.
zipSize (Function)
Returns the size of the archive (in ZIP, RAR, CAB, WDZ, 7z, gzip, TAR or TGZ (TAR.GZ) format):
  • the size of all compressed files found in the archive.
  • the size of all files found in the archive before compression.
<zipArchive variable>.OpenRAR (Function)
Opens an existing archive in RAR format.
<zipArchive variable>.FileSize (Function)
Returns the size of one of the archive files (in CAB, RAR, WDZ, ZIP, 7z, gzip, TAR or TGZ (TAR.GZ) format):
  • the compressed size of the file.
  • the size of file before compression.
<Connection variable>.InfoFileProperty (Function)
Gets the properties of a data file located in an HFSQL server.
sOpen (Function)
Opens and initializes:
  • a serial port.
  • a parallel port.
  • an infrared port.
zipNbPart (Function)
Returns the number of sub-archives (parts) of an archive in CAB, RAR, ZIP, WDZ, 7z, gzip, TAR or TGZ (TAR.GZ) format.
ODBCDatabaseName (Property)
The ODBCNameBase property allows you to:
  • Find out the name of the database used when printing a report based on a "query performed on a connection".
  • Specify the name of the database used when printing a report based on a "query performed on a connection".
<emailIMAPSession variable>.CloseSession (Function)
Closes an IMAP session.
Opening
The Opening keyword...
zipOpenRAR (Function)
Opens an existing archive in RAR format.
<DiskFile variable>.Open (Function)
Opens an external file (ANSI or Unicode) so that it can be manipulated programmatically
<EmailNotesSession variable>.GetAll (Function)
Retrieves all the emails found on a Notes server.
HSubstDir (Function)
Associates the data directory specified in the analysis with a directory found on disk.
<EmailOutlookSession variable>.GetAll (Function)
Retrieves all the emails found on an Outlook server.
HDescribeConnection (Example)
Usage example of the HDescribeConnection function
OutlookStartSession (Function)
Allows you to access data handled by the Outlook messaging software (emails, contacts, groups of contacts, tasks, appointments and folders).
<Source>.ChangeConnection (Function)
Dynamically changes the connection associated with a data file.
Window with parameters
A window can:
  • Receive parameters when it is opened.
  • Return values when it is closed.
EmailStartIMAPSession (Function)
Starts a session for receiving and reading emails with the IMAP protocol.
<DiskFile variable>.Read (Function)
Reads:
  • a block of bytes (characters) in an external file (ANSI or Unicode),
  • the content of an external file (ANSI or Unicode) and assigns it to a memory area.
zipFileSize (Function)
Returns the size of one of the archive files (in CAB, RAR, WDZ, ZIP, 7z, gzip, TAR or TGZ (TAR.GZ) format):
  • the compressed size of the file.
  • the size of file before compression.
<emailSMTPSession variable>.CloseSession (Function)
Closes an SMTP session.
<zipArchive variable>.DeleteAll (Function)
Deletes all files from an archive.
IMAP protocol
The IMAP protocol is a standard protocol for managing emails...
<DiskFile variable>.Unlock (Function)
Entirely or partially unlocks an external file.
EmailChangeFolder (Function)
Modifies the current folder in the messaging software (Outlook, messaging software using the IMAP protocol, ...).
<emailOutlookSession variable>.ListFolder (Function)
Returns the list of folders found in the Outlook messaging software.
WinAnimationOpening (Function)
Modifies the type and duration of animations used when opening the application windows.
zipDeleteAll (Function)
Deletes all files from an archive.
<emailIMAPSession variable>.StartSession (Function)
Starts an IMAP session.
HModifyStructure (Example)
Usage example of the HModifyStructure function
EmailRemoveFolder (Function)
Deletes a folder from the Outlook messaging software or from an IMAP server.
<emailPOP3Session variable>.CloseSession (Function)
Closes a POP3 session.
zipExtractAll (Function)
Extracts all files from an archive and decompresses them.
ContactDelete (Function)
Deletes the current contact:
  • from a Lotus Notes or Outlook address book.
  • in the Phone contacts list (Android, iPhone or iPad).
sParameter (Function)
Defines or modifies the parameters for configuring the specified serial port, parallel port or infrared port.
Managing the emails with the POP3/SMTP protocols
The POP3 and SMTP protocols are protocols for email management recognized by all Internet Service Providers...
zipOpen (Function)
Opens an existing archive.
The planes (in a window or in a report)
The planes are used to group the window controls...
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.
<zipArchive variable>.Merge (Function)
Merges the different sub-archives found in a multi-part archive to create a single-part archive.
SendMessage (Function)
Sends a Windows message to a control or to a window.
HCheckStructure (Function)
Defines the mode for comparing data files.
EmailListFolder (Function)
Returns the list of folders:
  • found in the Outlook messaging software.
  • for an IMAP session.
<EmailPOP3Session variable>.GetAll (Function)
Retrieves all the emails found on a POP3 server.
EmailCloseSession (Function)
Closes an email management session depending on the selected mode (SMTP/POP3, IMAP, MS Exchange or Lotus Notes).
WLanguage procedure called by the fReadLine function
WLanguage procedure ("Callback") called by fReadLine for each line read in the file.
fWrite (Example)
Usage example of the fWrite function
EmailSeekFirstNotes (Function)
Seeks one or more emails according to specified criteria, in a local or remote Lotus Notes or Domino database.
Creating the Vision pages of the WEBDEV RAD pattern
Detailed use of WINDEV FTP/RPC
WLanguage procedure called by fMemOpen
Procedure ("Callback") called by fMemOpen if the memory area is modified by another WLanguage application.
zipMerge (Function)
Merges the different sub-archives found in a multi-part archive to create a single-part archive.
<DiskFile variable>.Write (Function)
Writes:
  • a character string to an external file.
  • a memory section.
Report based on an Organizer control
A report based on an Organizer control is used to directly print the information displayed in the Organizer control
TaskFirst (Function)
Reads the first task in a Lotus Notes or Outlook task list.
<EmailIMAPSession>.GetAll (Function)
Retrieves all the emails found on an IMAP server.
<Source>.Password (Function)
Defines the password used to create or open a data file.
EmailGetAll (Function)
Retrieves all the emails found on a server.
HPass (Function)
Defines the password used to create or open a data file.
Report based on a Scheduler control
A report based on a Scheduler control is used to directly print the information displayed in the Scheduler control...
Non-modal management of a window
The window that opens another window is called parent window ; the windows opened by the parent window are called child windows...
ActionPlanConfigure (Function)
Configures an action plan in the software factory.
<DiskFile variable>.ReadLine (Function)
Reads a line from an external file (ANSI or Unicode).
HOpenConnection (Function)
Opens a connection to a specific database.
<zipArchive variable>.InfoFile (Function)
Returns the characteristics of a file found an archive:
  • The name of the file and its stored path.
  • The initial size of the file.
  • The compressed size of file.
  • The date and time of file creation.
  • The date and time of file modification.
  • The date and time of file access.
  • The file attributes.
  • The file encryption mode.
EmailStartSession (Function)
Starts an email management session based on the selected management mode (POP3, SMTP, IMAP or MS Exchange).
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.
zipExtractDirectory (Function)
Automatically extracts and decompresses files from a directory in the file tree of an archive to a physical location.
<zipArchive variable>.ExtractDirectory (Function)
Automatically extracts and decompresses files from a directory in the file tree of an archive to a physical location.
zipInfoFile (Function)
Returns the characteristics of a file found an archive:
  • The name of the file and its stored path.
  • The initial size of the file.
  • The compressed size of file.
  • The date and time of file creation.
  • The date and time of file modification.
  • The date and time of file access.
  • The file attributes.
  • The file encryption mode.
Report based on a TreeView Table control
You can use a report based on a TreeView Table control to directly print the information displayed in a TreeView Table control found...
EmailReadMessage (Example)
Usage example of the EmailReadMessage function
iPrintSignature (Function)
Prints an image of the signature in a rectangular area.
Handling RTF in an Edit control
Rich Text Format (RTF) is used to encode text and simplify exchange between applications...
Manipulating a database from a Java application
You can start developing your application as soon as the WINDEV project is defined as being a Java project...
Connection (Variable type)
The Connection type is used to describe one or more connections to external databases (HFSQL Client/Server, Native Connector, etc, ...
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.
Creating the Relation windows of a WINDEV RAD pattern
emailSMTPSession (Variable type)
The emailSMTPSession type is used to access a messaging server by using the SMTP protocol (Simple Mail Transfer Protocol) in order to send emails.
HSubstDir (Example)
Usage example of the HSubstDir function
<zipArchive variable>.Split (Function)
Splits an archive into several sub-archives of a given size.
HDescribeConnection (Function)
Describes a new connection to an external database.
zipSplit (Function)
Splits an archive into several sub-archives of a given size.
<zipArchive variable>.ExtractAll (Function)
Extracts all files from an archive and decompresses them.
CertificateCheckString (Function)
Checks the correspondence between a signature and a string.
NumHelp (Function)
Returns the number of the help context associated with the specified control.
Error handling WLanguage procedure called by zipExtractDirectory
WLanguage procedure ("Callback") called if an error is encountered when extracting files with zipExtractDirectory.
DomoClose (Function)
Closes the communication opened by DomoOpen.
TimerSys (Function)
Periodically and automatically calls a WLanguage procedure.
sWrite (Function)
Writes a character string to the output buffer of the specified serial port, parallel port or infrared port.
HandleParentNext (Function)
Forces the parent of the next window to open.
zipExtractFile (Function)
Extracts a file from an archive and automatically decompresses it to a physical location or in memory.
Gantt Chart report
The report editor gives you the ability to create "Gantt Chart" reports...
zipExtractFileList (Function)
Extracts and decompresses a list of files found in an archive to a physical location.
Report based on a Looper control
A report based on a Looper control is used to directly print the information displayed in the control...
Writing an email
Writing an email in WLanguage consists in filling the email structure of WLanguage...
TaskDelete (Function)
Deletes the current task from the task list of a Lotus Notes or Outlook messaging.
<emailOutlookSession variable>.ChangeFolder (Function)
Modifies the current folder in the Outlook messaging software.
GroupDelete (Function)
Deletes the current group of contacts from a Lotus Notes or Outlook address book.
Report based on a Table control
A report based on a Table control is used to directly print the information displayed in the control (data-bound or populated programmatically) ...
<emailOutlookSession variable>.CurrentFolder (Function)
Returns the name of the current folder in the Outlook messaging software.
<emailOutlookSession variable>.AddFolder (Function)
Adds a folder into the Outlook messaging software.
DomoStatus (Function)
Used to find out whether an electrical device (compatible with the X10 protocol) is switched on or off.
<EmailOutlookSession variable>.Update (Function)
Updates the messages of MS Exchange according to the email server.
GroupModify (Function)
Modifies the current group of contacts in a Lotus Notes or Outlook address book.
TaskNext (Function)
Reads the task after the current task in a Lotus Notes or Outlook task list.
GroupRead (Function)
Reads a group of contacts in a Lotus Notes or Outlook address book.
GroupFirst (Function)
Reads the first group of contacts in a Lotus Notes or Outlook address book.
<zipArchive variable>.OpenCAB (Function)
Opens an existing archive in CAB format.
GroupLast (Function)
Reads the last group of contacts in a Lotus Notes or Outlook address book.
GroupPrevious (Function)
Reads the group of contacts before the current group in a Lotus Notes or Outlook address book.
GroupNext (Function)
Reads the group of contacts after the current group in a Lotus Notes or Outlook address book.
Creating the menus for the pages of the WEBDEV RAD pattern
Page with parameters
Creating the link buttons in the windows of a WINDEV RAD pattern
DomoSend (Function)
Sends a command to one or more electrical devices compatible with the X10 protocol.
Managing emails with "Simple MAPI"
Simple MAPI simplifies the management of emails received by the hosting provider...
2026 new features brochure: WINDEV new features
What's new in WINDEV 2026 in the What's new 2026 brochure.
1
…
8