HTTPSendForm (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Security error in a secure transaction
Retrieval
Accessing a password-protected URL
Using a proxy
Authentication headers
Required application feature

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

HTTPSendForm (Function)

In french: HTTPEnvoieFormulaire

Sends an HTTP form. This form was created by HTTPCreateForm.

Versions 16 and later

This function is now available for PHP sites.

This function is now available for WINDEV applications in Linux.

New in version 16

This function is now available for PHP sites.

This function is now available for WINDEV applications in Linux.

This function is now available for PHP sites.

This function is now available for WINDEV applications in Linux.

Versions 18 and later

This feature is now available for iPhone/iPad applications, but only in HTTP, not HTTPS..

New in version 18

This feature is now available for iPhone/iPad applications, but only in HTTP, not HTTPS..

Versions 19 and later

This function is now available in Android Widget mode.

This function is now available for Android applications.

New in version 19

This function is now available in Android Widget mode.

This function is now available for Android applications.

This function is now available in Android Widget mode.

This function is now available for Android applications.

Versions 20 and later

This feature is now available for iPhone/iPad applications in HTTPS.

This function is now available for applications and sites in Linux in HTTPS.

New in version 20

This feature is now available for iPhone/iPad applications in HTTPS.

This function is now available for applications and sites in Linux in HTTPS.

This feature is now available for iPhone/iPad applications in HTTPS.

This function is now available for applications and sites in Linux in HTTPS.

Example

See additional examples

HTTPCreateForm("FORM")
HTTPAddParameter("FORM", "Price", "3400")
...
HTTPSendForm("FORM", "www.mysite.com")

// Example for sending a file
lIdForm = "TEST"
HTTPCreateForm(lIdForm)
HTTPAddFile(lIdForm, "file", "C:\temp\Certificate.pdf")
IF NOT HTTPSendForm(lIdForm, "http://test.myserver.net", httpPost, "AGENT") THEN
...
END

Syntax

Full syntax Hide the details

<Result> = HTTPSendForm(<Form name> , <URL to contact> [, <HTTP Method> [, <User agent> [, <Additional HTTP header> [, <Type of form> [, <Username> [, <Password>]]]]]])

<Result>: Boolean

True if the HTTP form was sent,
False if an error occurred. To get the details of the error, use ErrorInfo with the errMessage constant.

<Form name>: Character string (with quotes)

Name of HTTP form to send.

<URL to contact>: Character string (with quotes)

Address of server to contact (URL address).
This parameter can contain the port number for connecting to the server. The default value is 80 (corresponds to a server of Web pages). To specify a port number, use the following format: "<Server URL>:<Port #>".
For example: http://www.pcsoft.fr:80.
Remark: To perform a secure transaction, the URL must start with "https://".

<HTTP Method>: Optional Integer constant

HTTP method used:
Versions 19 and later
httpCopy
New in version 19
httpCopy
httpCopy COPY method
httpDelete DELETE method
httpGet GET method
Versions 19 and later
httpHead
New in version 19
httpHead
httpHead HEAD method
Versions 19 and later
httpPatch
New in version 19
httpPatch
httpPatch PATCH method
httpPost
(Default value) POST method
httpPut PUT method
Not available.

<User agent>: Optional character string (with quotes)

Identifies the client. The "PC SOFT Framework" value is returned by default.
The content of the response may depend on the user agent. In this case, see the documentation of user agent for more details.
Identifies the client. The "Mozilla/4.0 (compatible; MSIE 4.01 - Windows CE)" value is returned by default.
Indeed, the content of the response may depend on the user agent. For example, if the default value is used, the size of pages displayed will be adapted to the Pocket PC screen (only if this features is supported by the server of site viewed).

<Additional HTTP header>: Optional character string (with quotes)

Additional HTTP header that will be added to the HTTP message. Caution: this string must end with a CR character (Carriage Return).
Empty string ("") if no HTTP header must be added.

<Type of form>: Optional character string (with quotes) or optional constant

Type of form that will be sent to the server. This parameter corresponds to "Content-Type".
By default, the message type corresponds to: "application/x-www-form-urlencoded".
Versions 22 and later
This parameter can correspond to one of the following constants:
typeMimeMultiPartForm The message type corresponds to: "multipart/form-data" (mainly used to transfer files).
typeMimeSimpleForm
(Default value) The message type corresponds to: "application/x-www-form-urlencoded".
New in version 22
This parameter can correspond to one of the following constants:
typeMimeMultiPartForm The message type corresponds to: "multipart/form-data" (mainly used to transfer files).
typeMimeSimpleForm
(Default value) The message type corresponds to: "application/x-www-form-urlencoded".
This parameter can correspond to one of the following constants:
typeMimeMultiPartForm The message type corresponds to: "multipart/form-data" (mainly used to transfer files).
typeMimeSimpleForm
(Default value) The message type corresponds to: "application/x-www-form-urlencoded".

<Username>: Optional character string (with quotes)

Name used to access a page with a protected URL (empty string by default). This name is used to identify the user.

<Password>: Optional character string (with quotes)

Password associated with the user name (empty string by default). Used to access a page with a protected URL. Caution: The password is not encrypted when it is sent on Internet.

Versions 20 and later

Syntax available in Android and Android widget from version 26 onwards

Syntax with the httpRequest type Hide the details

<Result> = HTTPSendForm(<Form name> , <HTTP request>)

<Result>: httpResponse variable

Name of httpResponse variable containing the response from the request.

<Form name>: Character string (with quotes)

Name of HTTP form to send.

<HTTP request>: httpRequest variable

Name of httpRequest variable containing the parameters required to send the form.

New in version 20

Syntax available in Android and Android widget from version 26 onwards

Syntax with the httpRequest type Hide the details

<Result> = HTTPSendForm(<Form name> , <HTTP request>)

<Result>: httpResponse variable

Name of httpResponse variable containing the response from the request.

<Form name>: Character string (with quotes)

Name of HTTP form to send.

<HTTP request>: httpRequest variable

Name of httpRequest variable containing the parameters required to send the form.

Syntax available in Android and Android widget from version 26 onwards

Syntax with the httpRequest type Hide the details

<Result> = HTTPSendForm(<Form name> , <HTTP request>)

<Result>: httpResponse variable

Name of httpResponse variable containing the response from the request.

<Form name>: Character string (with quotes)

Name of HTTP form to send.

<HTTP request>: httpRequest variable

Name of httpRequest variable containing the parameters required to send the form.

Versions 26 and later

Asynchronous syntax that uses the httpRequest type Hide the details

HTTPSendForm(<Form name> , <HTTP request> , <WLanguage procedure>)

<Form name>: Character string (with quotes)

Name of HTTP form to send.

<HTTP request>: httpRequest variable

Name of httpRequest variable containing the parameters required to send the form.

<WLanguage procedure>: Procedure name

Name of WLanguage procedure called during the response from the HTTP server. This procedure has the following format:

PROCEDURE <Procedure name>(<Response> is httpResponse)

where <Response> is an httpResponse variable containing the response received from the HTTP server.

New in version 26

Asynchronous syntax that uses the httpRequest type Hide the details

HTTPSendForm(<Form name> , <HTTP request> , <WLanguage procedure>)

<Form name>: Character string (with quotes)

Name of HTTP form to send.

<HTTP request>: httpRequest variable

Name of httpRequest variable containing the parameters required to send the form.

<WLanguage procedure>: Procedure name

Name of WLanguage procedure called during the response from the HTTP server. This procedure has the following format:

PROCEDURE <Procedure name>(<Response> is httpResponse)

where <Response> is an httpResponse variable containing the response received from the HTTP server.

Asynchronous syntax that uses the httpRequest type Hide the details

HTTPSendForm(<Form name> , <HTTP request> , <WLanguage procedure>)

<Form name>: Character string (with quotes)

Name of HTTP form to send.

<HTTP request>: httpRequest variable

Name of httpRequest variable containing the parameters required to send the form.

<WLanguage procedure>: Procedure name

Name of WLanguage procedure called during the response from the HTTP server. This procedure has the following format:

PROCEDURE <Procedure name>(<Response> is httpResponse)

where <Response> is an httpResponse variable containing the response received from the HTTP server.

Remarks

Security error in a secure transaction

During a secure transaction, the sending of the form may fail due to security errors:

invalid certificate or certificate coming from an unknown company.
the name of the site specified in the certificate does not correspond to a server.
invalid or expired certificate date.
redirection to a non-secure server.

These errors are returned by ErrorInfo.

If one of these errors occurs, you can re-run the request while ignoring the errors.

Two methods can be used according to the syntax:

Syntax 1: using the HTTP.IgnoreError variable (see the paragraph below).
Versions 20 and later
Syntax 2: using the ..IgnoreError property of httpRequest variable.
New in version 20
Syntax 2: using the ..IgnoreError property of httpRequest variable.
Syntax 2: using the ..IgnoreError property of httpRequest variable.

If the full syntax is used (syntax 1), all you have to do is use the HTTP.IgnoreError variable:

Error returned by ErrorInfo (with the errCode constant)	Value of HTTP.IgnoreError (these values can be combined)	Description

httpErrorInvalidCertificate Invalid certificate or certificate coming from an unknown company	httpIgnoreInvalidCertificate	The certificate is ignored.
httpErrorInvalidCertificateName The site name specified in the certificate does not correspond to a server	httpIgnoreInvalidCertificateName	The site name specified in the certificate is ignored.
httpErrorExpiredCertificate Invalid or expired certificate date	httpIgnoreExpiredCertificate	The certificate date is ignored
httpErrorRedirectToHTTP Redirection to a non-secure server	httpIgnoreRedirectToHTTP	The redirection to a non-secure server is allowed.
httpIgnoreRedirectToHTTPS Redirection to a secure server	httpIgnoreRedirectToHTTPS	The redirection to a secure server is allowed.

For example:

// Send a form on a secure server
ResStart = HTTPSendForm("FORM", "https://www.MyServer.com")
// If an error occurs
IF ResStart = False THEN
// According to the type of error
SWITCH ErrorInfo(errCode)
// Invalid certificate or coming from an unknown company
CASE httpErrorInvalidCertificate:
// Ignore the certificate?
IF YesNo("Caution, a security alert was detected!", ...
"The certificate is invalid.", ...
"Do you want to ignore this certificate?") = Yes THEN
HTTP.IgnoreError = httpIgnoreInvalidCertificate
// Send the form again while ignoring this error
HTTPSendForm("FORM", "https://www.MyServer.com")
END
// Invalid or expired certificate date
CASE httpErrorExpiredCertificate:
// Ignore the certificate date?
IF YesNo("Caution, a security alert was detected!", ...
"The certificate date is invalid or expired.", ...
"Do you want to ignore this date?") = Yes THEN
HTTP.IgnoreError = httpIgnoreExpiredCertificate
// Send the form again while ignoring this error
HTTPSendForm("FORM", "https://www.MyServer.com")
END
END
END

The errors regarding the security of transactions are not returned by ErrorInfo (the connection is refused). These errors cannot be ignored. The HTTP.IgnoreError variable is not available.

Retrieval

HTTPGetResult retrieves the result of the last HTTP form sent.

Accessing a password-protected URL

To access a password-protected URL, you can:

use the <User name> and <Password> parameters in HTTPSendForm.
specify the username and password in the <URL to contact> parameter.
For example:

<Result> = HTTPSendForm("http://<user>:<password>@<URL to contact>")

Using a proxy

To access the URL specified in HTTPSendForm via a proxy, use Proxy.

Authentication headers

The authentication headers are automatically generated in the following cases:

If HTTPSendForm uses the syntax with username and password.
If the server URL is password protected
If Proxy is used.

Versions 21 and later

Required application feature

The use of this function triggers the declaration of one application feature in the application generation wizard.

Required feature: Internet and public networks (outgoing).

This feature allows the applications to use the accesses to Internet and to the public networks.

New in version 21

Required application feature

The use of this function triggers the declaration of one application feature in the application generation wizard.

Required feature: Internet and public networks (outgoing).

This feature allows the applications to use the accesses to Internet and to the public networks.

Required application feature

The use of this function triggers the declaration of one application feature in the application generation wizard.

Required feature: Internet and public networks (outgoing).

This feature allows the applications to use the accesses to Internet and to the public networks.

Business / UI classification : Business Logic

Component : wd260com.dll