ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Version: 2025

<Variable Connexion>.RSIgnoreError (Function)
Ignores errors so that replication between HFSQL servers can continue to run.
<Connection variable>.TransactionSavepoint (Function)
Declares a transaction savepoint.
<Connection variable>.InfoUser (Function)
Updates the variables for user management with the information regarding the specified user.
gglAuthor (Variable type)
The gglAuthor type is used to identify the author of a Google element...
<HFSQL connection>.CheckIndexAsynchronous (Function)
Checks that the data contained in the index file (.NDX file) correctly references the data contained in the HFSQL Client/Server data file (.FIC file).
This function is only available in subscription-based versions, starting with WINDEV Suite 2025 - Update 2.
Source (Property)
The Source property can be used on:
  • Chart control field field: in this case, the Source property indicates the source of the series: table column, list of values, etc, ...
  • connection in which case the Source property is used to identify or define the source of a connection (HFSQL Client/Server, OLE DB, etc.).
<Connection variable>.ExecuteAsynchronousProcedure (Function)
Executes a stored procedure in asynchronous mode.
This function is only available in subscription-based versions, starting with WINDEV Suite 2025 - Update 2.
HChangeDir (Function)
Changes the path to a data file (i.e. directory in which the file will be handled).
<Connection variable>.InfoDatabaseProperty (Function)
Used to find out the properties of a database on an HFSQL server.
memcachedConnection (Variable type)
The memcachedConnection type is used to define the characteristics of a connection to a Memcached server.
<Connection variable>.TransactionCancel (Function)
If a transaction is in progress, rolls back all operations performed on data files in transactions since the start of the transaction.
HRSListConfig (Function)
Lists the replications available on a master HFSQL server.
<Connection variable>.InfoTask (Function)
Returns the characteristics of a scheduled task in a hScheduledTask variable].
<Connection variable>.SecurityPolicyUnlockAccount (Function)
Unlocks a user account that has been locked due too many unsuccessful login attempts.
This function is only available in subscription-based versions, starting with WINDEV Suite 2025 - Update 3.
DomoSwitchOff (Function)
Switches off one or more electrical devices compatible with the X10 protocol.
<Connection variable>.InfoFileProperty (Function)
Allows you to find out the properties of a data file located in an HFSQL server.
<Connection variable>.ModifyGroup (Function)
Modifies the group information according to the elements found in the corresponding variables for group management.
<Connection variable>.SecurityPolicySet (Function)
Sets the password security policy of an HFSQL server.
This function is only available in subscription-based versions, starting with WINDEV Suite 2025 - Update 3.
<Connection variable>.ModifyServerRights (Function)
Sets the rights granted to a user or group on an HFSQL server.
<EmailOutlookSession variable>.StartSession (Function)
Starts an Outlook section.
<Connection variable>.NotifDeleteEmailRecipient (Function)
Deletes the recipients of an email notification.
gglNotification (Variable type)
The gglNotification type is used to define information about event notifications in a calendar.
Detailed use of WINDEV FTP/RPC
EmailStartIMAPSession (Function)
Starts a session for receiving and reading emails with the IMAP protocol.
GglConnect (Function)
Manages authentication on a Google server (via the "OAuth 2.0" authentication mode).
GglGetDocument (Function)
Downloads a document from Google Docs.
<Connection variable>.InfoFile (Function)
Returns the characteristics of an HFSQL Classic or Client/Server data file.
<Connection variable>.ModifyScheduledOptimization (Function)
Modifies a scheduled optimization task on the HFSQL server defined by the connection.
<Connection variable>.ModifyViewRights (Function)
Sets the rights granted to a user or group on an SQL view or on a materialized view.
<Connection variable>.InfoViewRights (Function)
Gets the rights granted to a user or group on an SQL view or on a materialized view.
<Connection variable>.DeleteSet (Function)
Deletes a set of stored procedures from an HFSQL server.
<Connection variable>.SecurityPolicyGet (Function)
Gets the security policy of an HFSQL server.
This new function is available from version 2025 Update 3.
HTransaction (Function)
Starts a transaction on the data files (HFSQL or accessed via a Native Connector) and creates the transaction file.
<Connection variable>.TransactionStart (Function)
Starts a transaction on the data files (HFSQL or accessed via Native Access) and creates the transaction file.
<Connection variable>.DeleteScheduledBackup (Function)
Deletes a scheduled backup from an HFSQL Client/Server server.
<Connection variable>.DeleteTask (Function)
Deletes a scheduled task from an HFSQL Client/Server server.
<Connection variable>.ModifyScheduledBackup (Function)
Modifies a backup scheduling.
DDESend (Function)
Sends a data to the program connected via DDE.
<gglConnection variable>.GetDocument (Function)
Downloads a document from Google Docs.
<Connection variable>.DeleteBackup (Function)
Deletes a backup previously created with HBackup.
<hdfsConnection variable>.CopyTo (Function)
Copies a file located on the local machine to a Hadoop server.
<Connection variable>.TransactionIsolation (Function)
Configures the isolation level of transactions for a connection to an HFSQL server.
<Connection variable>.ModifyServerProperty (Function)
Modifies the properties of an HFSQL server.
HDeclareExternal (Example)
Usage example of the HDeclareExternal function
gglAttachment (Variable type)
The gglAttachment type is used to define all the advanced characteristics of a file attached to a calendar event. The calendar can be described using the gglCalendar type. This calendar is used by the Google Calendar service.
<Connection variable>.SecurityPolicyCheck (Function)
Checks that each user accounts complies with the password security policy associated with the HFSQL server.
This function is only available in subscription-based versions, starting with WINDEV Suite 2025 - Update 3.
<Connection variable>.RestoreBackup (Function)
Used to restore:
  • an immediate backup (performed by HBackup or via the HFSQL Control Center),
  • a scheduled backup (described by HAddScheduledBackup or via the HFSQL Control Center.
<Connection variable>.TransactionList (Function)
Returns the list of current or interrupted transactions on the server for the specified connection.
<Connection variable>.RSWaitForDataProcess (Function)
Waits for:
  • the replication data on the master server to be sent to the subscriber server.
  • the replication data received on the subscriber server to be entirely applied.
<Connection variable>.ModifyItemRights (Function)
Modifies the rights granted to a user or group on an item of an HFSQL Client/Server data file.
<HFSQL connection>.ListReindexingHistory (Function)
Lists the operations performed on current data files, over the last 24 hours, or on the last 1000 files. These operations include reindexing, recalculation of statistics, memo verification, index verification, etc.
This function is only available in subscription-based versions, starting with WINDEV Suite 2025 - Update 2.
gglContactGroup (Variable type)
The gglContactGroup is used to describe and modify a group of contacts used by the Google Contacts service...
SocketProxy (Function)
Specifies whether TCP sockets and WebSockets must go through a SOCKS5 proxy to execute requests.
<Connection variable>.PriorityClient (Function)
Modifies the priority of a client application.
<Connection variable>.RSTransformSpareIntoServer (Function)
Transforms a Spare server into an HFSQL server. This makes it possible to delete replications of a spare server so that it can be used again. For example, this function can be used in the case of a master server that becomes unreachable.
This function should only be used in a critical situation.
Note: This function is only available from version 2025 Update 1.
StreamReject (Function)
Refuses a request for stream connection.
<Connection variable>.DeleteServerTrigger (Function)
Deletes a server trigger.
HTransactionCancel (Function)
If a transaction is in progress, rolls back all operations performed on data files in transactions since the start of the transaction.
<Connection variable>.DeleteDirectory (Function)
Deletes a directory from an HFSQL Client/Server database.
HUpdateQuery (Function)
Creates or updates a query on an HFSQL server.
<Connection variable>.ActivateServerTrigger (Function)
Re-enables a server trigger that was disabled by HDeactivateServerTrigger.
<Connection variable>.SimulateNetwork (Function)
Simulates the operating mode of HFSQL Client/Server on an ADSL or 3G network.
<Connection variable>.DeactivateServerTrigger (Function)
Disables an HFSQL Client/Server server trigger on a server.
<Connection variable>.LoadParameter (Function)
Reads a parameter that was saved from a stored procedure by HSaveParameter.
Single Page App
A "Single Page App" is a Web application (Internet or Intranet) whose all pages are grouped in a single page...
<Source>.InfoFile (Function)
Returns the characteristics of an HFSQL Classic or Client/Server data file.
Compression (Property)
The Compression property is used to manage data compression during a connection (HFSQL Client/Server, etc.)
<Connection variable>.DeleteDatabase (Function)
Deletes a database located on an HFSQL server.
<Connection variable>.NotifListEmailRecipient (Function)
Returns the list of recipients for a notification by email.
ModbusConnectTCP (Function)
Connects a client to a Modbus server via transmission control protocol (TCP).
HStartServer (Function)
Allows you to start an HFSQL server (this function uses the MantaManager service).
<Connection variable>.DeleteGroup (Function)
Deletes (from the server) a group of users associated with a connection.
modbusSession (Variable type)
The modbusSession type is used to identify a connection to a Modbus server.
<Connection variable>.ManageTask (Function)
Enables or disables a scheduled task on an HFSQL Client/Server server.
NextTitle (Function)
Modifies the title of next window to open.
<Connection variable>.NotifListCCRecipient (Function)
Returns the list of recipients of a notification sent via the Control Centers (WDBal messaging tool).
<Connection variable>.DeleteUser (Function)
Deletes a user associated with a connection to the HFSQL server.
gglConnection (Variable type)
The gglConnection type is used to describe a connection to the Google services and to manage the authentication to different services...
SQL functions: Special case
List of SQL functions: Special cases
GglRequest (Function)
Sends a communication request (HTTP request) to a Google service.
<Connection variable>.UpdateQuery (Function)
Creates or updates a query on an HFSQL server.
hbColumnDescription (Variable type)
The hbColumnDescription type is used to define the advanced characteristics of a group of columns (items).
Connection (Variable type)
The Connection type is used to describe one or more connections to external databases (HFSQL Client/Server, Native Connector, etc.
<Connection variable>.ExecuteScheduling (Function)
Immediately executes a scheduled item regardless of its scheduling: scheduled task (stored procedure), backup, optimization, refresh of a materialized view.
<Connection variable>.ModifyScheduling (Function)
Modify a scheduled item on an HFSQL server: scheduled task (stored procedure), backup, optimization, refresh of a materialized view.
CtCacheSize (Property)
The CtCacheSize property is used to determine and change the maximum number of records that can be stored in the cache of the Native MySQL Connector.
<Source>.ChangeDir (Function)
Changes the path to a data file (i.e. directory in which the file will be handled).
SQLTransaction (Example)
Usage example of the SQLTransaction function
<Connection variable>.AddScheduling (Function)
Adds a new scheduled item to an HFSQL server: scheduled task (stored procedure), backup, optimization or refresh of a materialized view.
OBEXListFile (Function)
Lists the files shared by a device that uses the OBEX protocol.
<Connection variable>.ListTask (Function)
Lists the scheduled tasks of an HFSQL Client/Server server for a given connection.
<Connection variable>.DisconnectClient (Function)
Displays a message on the Client computer(s) and disconnects the application.
SQLColumn (Function)
Returns the characteristics of all the columns (or items):
  • for a given table.
  • for a given query.
<Connection variable>.ExecuteProcedure (Function)
Runs a stored procedure.
<Connection variable>.RSDeleteConfig (Function)
Deletes a replication between two HFSQL servers.
<Connection variable>.NotifAddEmailRecipient (Function)
Adds recipients for the notifications sent by email.
<Connection variable>.DeleteParameter (Function)
Deletes a parameter previously saved by HSaveParameter.
<Connection variable>.ExecuteScheduledBackup (Function)
Forces the execution of a scheduled backup.
StreamAccept (Function)
Associates a stream connection request with a Conference control.
<Connection variable>.NotifAddCCRecipient (Function)
Adds recipients for the notifications sent via the Control Centers (WDBal messaging tool).
gglDocument (Variable type)
The gglDocument type is used to handle a Google document...
<Connection variable>.ListScheduledOptimization (Function)
Lists the scheduled optimization tasks of HFSQL Client/Server data files for a connection.
<HFSQL connection>.CheckMemoAsynchronous (Function)
Checks the structural integrity of memos in an HFSQL Client/Server data file.
This function is only available in subscription-based versions, starting with WINDEV Suite 2025 - Update 2.
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>.ListScheduling (Function)
Lists scheduled elements defined on an HFSQL server: scheduled tasks (stored procedure), backup, optimization, refresh of a materialized view.
XMLOpen (Function)
Loads an XML document from a file, a URL or a string into an xmlDocument variable.
Managing WebSockets
WebSockets enable bidirectional communication between web applications (Intranet or Internet sites run in a browser) and web servers...
hbGetTableDescription (Function)
Retrieves the description of an HBase table.
<Connection variable>.AddScheduledOptimization (Function)
Adds an optimization task of HFSQL Client/Server data files.
<Connection variable>.RefreshView (Function)
Asks to recalculate the content of a materialized view.
MQTTPublish (Function)
Publishes a message on the MQTT broker.
HTransactionStart (Function)
Starts a transaction on the data files (HFSQL or accessed via a Native Connector) and creates the transaction file.
SOCKS5 protocol
SOCKS5 is a simple network protocol intended to standardize the use of proxies for applications...
hbRead (Function)
Reads cells (values of items) of a row (record) in an HBase table.
HRSIgnoreError (Function)
Ignores errors so that replication between HFSQL servers can continue to run.
FTPConnect (Function)
Connects the current computer to an FTP server (File Transfer Protocol).
<Connection variable>.DeleteFile (Function)
Deletes HFSQL data files (.fic, .ndx, .ftx, .sdx and .mmo files, if any) from the server.
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.
<Connection variable>.RegenerateFile (Function)
Regenerates a data file from its log.
<Connection variable>.ListSchedulingHistory (Function)
Lists the executions of a scheduled operation on an HFSQL server. This operation can be a scheduled task (stored procedure), backup, optimization or a materialized view refresh.
EmailStartSession (Function)
Starts an email management session based on the selected management mode (POP3, SMTP, IMAP or MS Exchange).
<Connection variable>.SendMessageToClient (Function)
Displays a message on the client computers.
ReplicAdmin: Overview
<Connection variable>.UpdateSet (Function)
Creates or updates a set of procedures on an HFSQL server.
<Connection variable>.ListScheduledBackup (Function)
Lists the full and differential backups that have been scheduled on HFSQL Client/Server.
gglCalendar (Variable type)
The gglCalendar type is used to describe and modify a calendar used by the Google Calendar service...
DomoClose (Function)
Closes the communication opened by DomoOpen.
<Connection variable>.ManageServerUpdate (Function)
Used to manage the automatic update of HFSQL Client/Server servers by specifying the check frequency regarding the availability of updates.
hdfsConnection (Variable type)
The hdfsConnection type is used to define the advanced characteristics of a connection to the Hadoop file system (HDFS).
Encryption (Property)
The Encryption property allows you to manage the type of encryption used between Client computers and an HFSQL server.
<HFSQL connection>.StatCalculateAsynchronous (Function)
Gets various statistics on the keys of an HFSQL Client/Server data file.
This function is only available in subscription-based versions, starting with WINDEV Suite 2025 - Update 2.
NetworkConnect (Function)
Associates a drive with a shared network directory.
<Connection variable>.SetIntegrity (Function)
Enables or disables the management of an integrity constraint on a file link.
<Connection variable>.AddScheduledBackup (Function)
Adds a scheduling for full backup (with or without differential backup) on the server defined by the connection.
NetworkDisconnect (Function)
Disconnects a network drive.
SQLAssociate (Function)
Automatically associates each column of the query result with a control or with a variable of the application.
WiFiConnectionInfo (Function)
Returns the requested information about the current Wi-Fi connection of the device.
CursorOptions (Property)
The CursorOptions property is used to manage the type of cursor used for a connection (Native Connectors, OLE DB, etc.).
HInfoServerRights (Function)
Gets the rights granted to a user or group of users on a server.
DeclareWebserviceContext (Function)
Used to declare a list of variables whose value will be persistent between the successive calls to a web service.
<Connection variable>.NotifConfigure (Function)
Specifies and configures the server used to send notifications by the HFSQL server.
gglEvent (Variable type)
The gglEvent type is used to describe and modify an event of a calendar...
<Connection variable>.DescribeServerTrigger (Function)
Adds or modifies a server trigger.
GglUploadDocument (Function)
Uploads a document to the Google server.
HStopServer (Function)
Stops an HFSQL server.
<gglConnection variable>.UploadDocument (Function)
Uploads a document to the Google server.
HOpenConnection (Function)
Opens a connection to a specific database.
OBEXSendFile (Function)
Sends a file to a device that supports the OBEX protocol.
SQLCol (Function)
Retrieves the content of the specified column from the query result, for the current line.
Customizing the WINDEV User Groupware
The User Groupware in automatic mode offers many possibilities...
HModifyScheduling (Function)
Modify a scheduled item on an HFSQL server: scheduled task (stored procedure), backup, optimization, refresh of a materialized view.
<Connection variable>.SetServer (Function)
Used to find out and modify some settings of HFSQL Client/Server server.
<Connection variable>.InfoDatabaseRights (Function)
Gets the rights granted to a user or group on a database.
HTransactionEnd (Function)
Validates the current transaction:
  • the modifications performed on the data file since the start of transaction (HTransactionStart) are validated.
  • the transaction file is deleted (if the transaction is the last transaction in progress for a network application)
  • the records locked in read-only by the transaction are unlocked.
HDescribeConnection (Function)
Describes a new connection to an external database.
iInitReportQueryConnection (Function)
Initializes the query linked to the report.
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).
<Report>.InitQueryConnection (Function)
Initializes the query linked to the report.
SQLGetCol (Function)
Retrieves the content of the specified column from the query result, for the current line.
How to include secure payment in a WEBDEV website?
This help page explains how to add a secure payment into a WEBDEV website...
EmailReadMessage (Example)
Usage example of the EmailReadMessage function
Handling WEBDEV Account Manager via command line
All the features in WEBDEV Account Manager can be used via command line...
Accessing a database in local mode (SQLite)
WEBDEV allows a site to create and access a database created by the browser on the computer of the Web user in browser code.
FTPProxy (Function)
Specifies whether the communication functions that use FTP must go through a proxy to run their requests.
<Connection variable>.InfoBackup (Function)
Returns information about one or more backups performed on an HFSQL Client/Server server.
HCopyFile (Example)
Usage example of the HCopyFile function
<HFSQL connection>.ReindexAsynchronous (Function)
Rebuilds the index of an HFSQL Client/Server data file (".NDX" file). This operation is asynchronous, i.e., it is performed on the server and does not block the client side.
This function is only available in subscription-based versions, starting with WINDEV Suite 2025 - Update 2.
Deployment diagram
A deployment diagram shows the physical layout of the hardware components (nodes) used in a system as well as the association between the executable programs and these components...
3. UML models in practice
3. UML models in practice
<Source>.ExecuteSQLQuery (Function)
Initializes a query written in SQL language and declares this query to the HFSQL engine.
gglLocation (Variable type)
The gglLocation type is used to describe and modify the location of an event found in a Google calendar...
SessionRequestedPage (Function)
Returns the name of the page requested at the start of the session.
HExecuteSQLQuery (Function)
Initializes a query written in SQL language and declares this query to the HFSQL engine.
CtExtendedInfo (Property)
The CtExtendedInfo property gets the additional information inserted into the database connection string.
OBEXConnect (Function)
Used to connect to a device that supports the OBEX protocol.  Reminder: The OBEX protocol is a data transfer protocol that can be used via infrared beams and Bluetooth.
LDAPMode (Function)
Modifies the operating mode of an LDAP session.
gglPostalAddress (Variable type)
The gglPostalAddress type is used to describe and modify the postal address of a contact...
Using Facebook authentication
Facebook is the world's most popular social network. It is commonly used by companies to reach their customers...
gglOrganization (Variable type)
The gglOrganization type is used to describe the companies and organizations to which a contact belongs...
gglPhoneNumber (Variable type)
The gglPhoneNumber type is used to describe and modify the phone number of a contact...
FaxRestart (Function)
Restarts a fax in the spooler.
Use Facebook authentication (prefix syntax)
Facebook is the world's most popular social network. It is commonly used by companies to reach their customers...
DDEError (Function)
Returns the runtime status report of a DDE function.
gglInstantMessaging (Variable type)
The gglInstantMessaging type is used to describe and modify the characteristics of an instant messaging program used by a contact...
<gglConnection variable>.ListDocument (Function)
Retrieves the list of documents available on the Google server for the current user.
DomoStatus (Function)
Used to find out whether an electrical device (compatible with the X10 protocol) is switched on or off.
GglFillCalendarByRequest (Function)
Fills a calendar that was previously retrieved: the events corresponding to the calendar are retrieved via a custom query.
Deployment via physical media (DVD, etc.)
<gglConnection variable>.FillCalendarByRequest (Function)
Fills a calendar that was previously retrieved: the events corresponding to the calendar are retrieved via a custom query.
gglOverride (Variable type)
The gglOverride type is used to define information about event notification overrides.
CtCursorOptions (Property)
The CtCursorOptions property gets the cursor type used when connecting to an external database.
SQLExec (Function)
Names and runs an SQL query.
FaxCompleteStatus Structure
The FaxCompleteStatus structure is automatically filled during the call to FaxStatus...
DomoSend (Function)
Sends a command to one or more electrical devices compatible with the X10 protocol.
CacheSize (Property)
The CacheSize property is used to:
  • Get the maximum number of records that can be stored in the cache of the Native MySQL Connector.
  • Change the maximum number of records that can be stored in the cache of the Native MySQL Connector.
Remote deployment via FTP or HTTP
Universal replication
The purpose of universal replication is to keep several databases synchronized...
HServerStatus (Function)
Allows you to find out the status of an HFSQL server (this function uses the MantaManager service).
1
9