WEB STARTBROWSE QUERYPARM

Description

WEB STARTBROWSE QUERYPARM signals the start of a browse of the keyword parameters, consisting of name and value pairs, from a query string in a URL.

For forms, you can also use the WEB STARTBROWSE FORMFIELD command. Forms are messages with the media types application/x-www-form-urlencoded or multipart/form-data.

Options

QUERYPARM(data-area)

is the keyword that initiates the STARTBROWSE QUERYPARM command. You can optionally specify the name of the keyword parameter at which browsing is to start, by specifying this in a data-area, followed by the NAMELENGTH option, for example,

WEB STARTBROWSE QUERYPARM(name) NAMELENGTH(len)

The name is a string of text containing the name of the requested keyword parameter. If a name is not specified, browsing starts at the first name and value pair in the query string.

HOSTCODEPAGE(data-value)

specifies the 8–character name of the CICS® (host) code page required by the application program, into which the query string data is to be converted. This code page is normally an EBCDIC code page.

The standard CICS form of a host code page name consists of the code page number (or more generally CCSID) written using 3 to 5 decimal digits as necessary then padded with trailing spaces to 8 characters. For code page 37, which is fewer than 3 digits, the standard form is 037. CICS now also accepts any decimal number of up to 8 digits (padded with trailing spaces) in the range 1 to 65535 as a code page name, even if it is not in the standard form.

If the code page is not specified, the data is returned in the EBCDIC code page specified by the LOCALCCSID system initialization parameter (which applies to the local CICS region, and has a default of 037), provided that the specified code page is supported by the CICS web interface. The code page is supported if it is one of a list of EBCDIC code pages that are recognized by CICS as being sufficiently standard to allow successful parsing of the web headers (this includes all SBCS CECP and Euro code pages). Otherwise, CICS returns the data in the default EBCDIC code page 037 instead.

NAMELENGTH(data-value)

specifies the length, as a fullword binary value, of the keyword parameter name. This field must be specified if a name data-area is specified with the QUERYPARM option.

Conditions

21 ILLOGIC

RESP2 value is:

5

A browse of keyword parameters is already in progress.

16 INVREQ

RESP2 values are:

1

The command is being issued in a non-CICS Web support application.

3

The command is being issued for a non-HTTP request.

12

The host code page cannot be found.

13

No keyword parameters found.

14

The code page combination for client and server is invalid.

17

Invalid keyword parameters found in the HTTP request.

22 LENGERR

RESP2 value is:

1

An invalid value for the NAMELEN parameter has been provided.

13 NOTFND

RESP2 value is:

1

Keyword parameter not found.