WEB STARTBROWSE FORMFIELD

Signal start of HTML form field browse.

Read syntax diagramSkip visual syntax diagram
WEB STARTBROWSE FORMFIELD

>>-WEB--STARTBROWSE--FORMFIELD(data-area)----------------------->

>--NAMELENGTH(data-area)---------------------------------------->

>--+----------------------------------------+------------------><
   '-CLNTCODEPAGE(name)--HOSTCODEPAGE(name)-'   

Conditions: INVREQ, LENGERR, NOTFND

This command is threadsafe.

Description

WEB STARTBROWSE FORMFIELD signals the start of a browse of a set of name-value pairs in an HTML form that is part of the body of an HTTP request being processed by the current CICS® task.

Options

CLNTCODEPAGE(name)
specifies the 40–character name of the character set that was used by the Web client for the HTTP request. If this is not specified, CICS obtains it from the charset parameter on the Content-Type header of the HTTP request. If the Content-Type header is not present, CICS assumes ISO-8859–1, the default character set for the Internet. If you specify CLNTCODEPAGE you must also specify HOSTCODEPAGE. CICS does not support all the character sets named by IANA. The CICS Internet Guide lists the IANA character sets that are supported by CICS for code page conversion.
FORMFIELD(data-area)
specifies the name of the form field at which browsing is to start. It is a string of text containing the name of the requested field. If a name is not specified, browsing starts at the first name/value pair in the HTML form.
HOSTCODEPAGE(name)
Start of changespecifies the 8–character name of the CICS (host) code page required by the application program, into which the form data is to be converted. If you specify HOSTCODEPAGE you must also specify CLNTCODEPAGE. This code page is normally an EBCDIC code page. If this is not specified, the default is the EBCDIC code page 037.

If the form data is in a query string (GET method), this option is ignored, and the data is returned in the EBCDIC code page specified by the LOCALCCSID system initialization parameter (which applies to the whole of the local CICS region, and has a default of 037). If the ASCII Latin-1 character set ISO-8859-1 (code page 819) cannot be converted into that code page, CICS uses the default EBCDIC code page 037 instead.

End of change
NAMELENGTH(data-value)
specifies the length, as a fullword binary value, of the form field name. This field must be specified if FORMFIELD is specified.

Conditions

INVREQ
occurs for the following conditions. 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.
5
There is already a WEB STARTBROWSE in progress.
11
The client code page cannot be found.
12
The host code page cannot be found.
13
No forms data has been supplied in the body of the HTTP request.
14
The code page combination for client and server is invalid.
Start of change17End of change
Start of changeInvalid forms data was found in the input message.End of change
LENGERR
occurs for the following conditions. RESP2 values are:
1
NAMELENGTH or VALUELENGTH is less than or equal to zero.
NOTFND
occurs for the following conditions. RESP2 values are:
1
The form field name given in the FORMFIELD parameter could not be found.