ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Version: 2025

Declaring a procedure/a function
The different syntaxes for declaring a procedure...
Global procedure/function
A global procedure can be used in all the processes or events of the project.
Parameters of a procedure/function
You have the ability to pass parameters to a procedure.
Passing parameters
The parameters can be passed to a procedure...
Parameters of a procedure with a variable number of parameters
When the procedure uses a variable number of parameters, you must be able to handle the different parameters passed to the function in the code of the procedure.
Typecasting of parameters
The description of the parameter type is optional...
Local procedure
Two types of procedures are available...
<upnpDevice variable>.ModifyBrightness (Function)
Modifies the brightness of a UPnP device.
<upnpDevice variable>.ModifyMute (Function)
Modifies the 'Mute' status of a UPnP device....
<sshSession variable>.ConnectShell (Function)
Starts a new SSH session of "Shell" type.
<sshSession variable>.DisconnectShell (Function)
Closes an SSH session that was opened by SSHConnectShell.
<sshSession variable>.Write (Function)
Writes data into the specified SSH session.
<sshSession variable>.Read (Function)
Reads the data found on the output buffer of the SSH session.
<ParallelTask variable>.Wait (Function)
Waits for the execution of a parallel task.
<ParallelTask variable>.RequestCancellation (Function)
Requests the cancellation of a parallel task.
<AuthToken variable>.OpenIDReadIdentity (Function)
Retrieves the identity of a user contained in an AuthToken variable.
<mongoCollection variable>.Add (Function)
Adds one or more documents into a collection of MongoDB database.
<mongoGridFS variable>.SendFile (Function)
Copies a file from the local computer to a MongoDB file system (gridFS).
<mongoGridFS variable>.ListFile (Function)
Retrieves the list of MongoDB files found in the MongoDB file system (gridFS).
<mongoGridFS variable>.GetFileByID (Function)
Retrieves (on the local computer) a file identified by its identifier and found in a MongoDB file...
<mongoGridFS variable>.GetFileInfo (Function)
Used to get information about a MongoDB file (gridFS).
<mongoGridFS variable>.DeleteFile (Function)
Deletes a file identified by its name from a MongoDB file system.
<mongoCollection variable>.ModifyOne (Function)
Modifies a document in a collection of MongoDB database.
<mongoCollection variable>.DeleteAll (Function)
Deletes all the documents (corresponding to the specified filter) from a collection of a MongoDB...
<websocketClient variable>.Disconnect (Function)
Disconnects a client from a WebSocket server.
<websocketClient variable>.Send (Function)
Sends a message from the WebSocket server to the client.
<websocketClient variable>.Execute (Function)
Executes a global procedure in the context of a client connected to the WebSocket server.
<String type>.AnsiToUnicode (Function)
Converts an ANSI string (Windows) to a UNICODE string.
<Buffer type>.AnsiToUnicode (Function)
Converts a buffer containing an ANSI string (Windows) to a buffer containing a UNICODE string.
<emailNotesSession variable>.SendMessage (Function)
Sends an email using the Lotus Notes protocol.
<emailOutlookSession variable>.SendMessage (Function)
Sends an email using the Outlook protocol.
<emailSMTPSession variable>.SendMessage (Function)
Sends an email using SMTP