com.HTTPRequest.doFormEncodedRequest

Performs an "application/x-www-form-urlencoded forms" encoded query.

Syntax

doFormEncodedRequest(
   query STRING,
   utf8 INTEGER )
  1. query defines a list of name/value pairs separated by an &.
  2. utf8 defines if the query string is UTF-8 encoded.

Usage

The doFormEncodedRequest() method performs a request with an "application/x-www-form-urlencoded forms" encoded query.

Supported methods are GET and POST.

The query string is a list of name/value pairs separated by an ampersand (&). For example:
name1=value1&name2=value2&name3=value3
Note: If you need to URL-encode the separator characters & and =, double them as following : na&&me=va==lue.

If the utf8 parameter is TRUE, the query string is encoded in UTF-8 as specified in XForms1.0, otherwise in ASCII as specified in HTML4.

This HTTP request method is non-blocking. It returns immediately after the call. Use the com.HTTPRequest.getResponse method, to perform a synchronous HTTP request, suspending the program flow until the response returns from the server. If the program must keep going, use the com.HttpRequest.getAsyncResponse method, to check if a response is available.

In case of error, the method throws an exception and sets the STATUS variable. Depending on the error, a human-readable description of the problem is available in the SQLCA.SQLERRM register. See Error handling in GWS calls (STATUS).

The INT_FLAG variable is checked during GWS API call to handle program interruptions, for more details, see Interruption handling in GWS calls (INT_FLAG)