Signal start of HTML form field browse.
WEB STARTBROWSE FORMFIELD
>>-WEB--STARTBROWSE--FORMFIELD-+-------------+------------------>
'-(data-area)-'
>--+-----------------------+------------------------------------>
'-NAMELENGTH(data-area)-'
>--+--------------------------+--+--------------------------+--><
'-CHARACTERSET(data-value)-' '-HOSTCODEPAGE(data-value)-'
Conditions: INVREQ, LENGERR, NOTFND
This command is threadsafe.
Description
WEB STARTBROWSE FORMFIELD signals
the start of a browse of a set of name and value pairs in an HTML
form that is part of the body of an HTTP request being processed by
the current CICS® task.
Options
- CHARACTERSET(name)
- specifies the 40–character name of
the character set that is required for encoding the form data. This
option should match the forms encoding determined by the corresponding
HTML form (see How the client encoding is determined for
more information). CICS does not support all the character
sets named by IANA. HTML coded character sets lists
the IANA character sets that are supported by CICS for
code page conversion.
- CLNTCODEPAGE(name)
- This option is supported for upgrade
purposes only. CHARACTERSET replaces it. The action taken by CICS is
the same for both keywords.
- FORMFIELD(data-area)
- is the keyword that initiates the STARTBROWSE
FORMFIELD command. You can optionally specify the name of the form
field at which browsing is to start, by specifying this in a data-area,
followed by the NAMELENGTH option, for example,
WEB STARTBROWSE FORMFIELD(name) NAMELENGTH(len)
The
name is a string of text containing the name of the requested field.
If a name is not specified, browsing starts at the first name and
value pair in the HTML form.
- HOSTCODEPAGE(name)
- specifies the 8–character name of the CICS (host)
code page required by the application program, into which the form
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 form field name. This field must be specified
if a name data-area is specified with the FORMFIELD option.
Conditions
- 21 ILLOGIC
- RESP2 value is:
- 5
- A browse of form fields is already in progress.
- 16 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.
- 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 HTTP request.
- 14
- The code page combination for client and server is invalid.
- 17
- Invalid forms data was found in the input message.
- 153
- The form type is unknown.
- 154
- A boundary string was expected in the forms data, but was not
found.
- 22 LENGERR
- occurs for the following conditions.
RESP2 values are:
- 1
- NAMELENGTH or VALUELENGTH is less than or equal to zero.
- 13 NOTFND
- occurs for the following conditions.
RESP2 values are:
- 1
- The form field name given in the FORMFIELD parameter could not
be found.