Progress
Language Reference


WEB-CONTEXT System Handle

Interfaces
OS
SpeedScript
All
All
Yes, not Progress

Provides access to information on the current connection to the Web server.

SYNTAX

WEB-CONTEXT  [ :attribute | :method ] 

attribute

An attribute of the WEB-CONTEXT handle. The attributes are listed in the table that follows:

Attribute
Type
Description
AUTO-DELETE-XML
LOGICAL
Determines whether the x-document object handle is deleted on a new web request. The default is YES.
CURRENT-
ENVIRONMENT
CHARACTER
Returns a list of CGI environment variable settings and http header information. Intended for internal use only, it is called by the get-cgi WebSpeed API function.
EXCLUSIVE-ID
CHARACTER
The ID assigned to a state-aware cookie. Intended for internal use only.
FORM-INPUT
CHARACTER
Raw http form input. Do not access this attribute.
HTML-END-OF-LINE
CHARACTER
Defaults to the newline character (ASCII 10; ’~n’; ’\n’). A null string value causes a NEWLINE character (not a null string) to be output. You might want to set this to "~n" (the NEWLINE character) or to the null string (to force the NEWLINE character). Depending on the other attribute values, using the NEWLINE rather than the <BR> tag can result in more readable output when viewing document source in a browser.
HTML-END-OF-PAGE
CHARACTER
Between stream pages, defaults to "<HR>".

Output between stream pages to visually break up the sectioning caused by the PAGED or PAGE-SIZE options of the OUTPUT TO "WEB" statement. Does not affect the line count of any stream page.
HTML-FRAME-BEGIN
CHARACTER
Before a SpeedScript frame, defaults to "<PRE>". Generally, if you change this value you must change the value of HTML-FRAME-END.

Output only before the data row(s) for the current iteration of a DOWN frame, not to column headers (see also HTML-HEADER-BEGIN and HTML-HEADER-END). Applies to any side-labels displayed in the frame, whether or not the frame is a DOWN frame.
HTML-FRAME-END
CHARACTER
After a SpeedScript frame, defaults to "</PRE>". Generally, if you change this value you must change the value of HTML-FRAME-BEGIN.

Output at the end of the data row(s) for the current iteration of a DOWN frame.
HTML-HEADER-BEGIN
CHARACTER
Before the column headers of a SpeedScript frame, defaults to "<PRE>". Generally, if you change this value you must change the value of HTML-HEADER-END.

Output at the beginning of the column header section of a DOWN frame.
HTML-HEADER-END
CHARACTER
After the column headers of a SpeedScript frame, defaults to "</PRE>". Generally, if you change this value you must change the value of HTML-HEADER-BEGIN.

Output at the end of the column header section of a DOWN frame.
HTML-TITLE-BEGIN
CHARACTER
Before a SpeedScript frame title, Defaults to the null string (""), no text. Generally, if you change this value you must change the value of HTML-TITLE-END.

Output before the frame’s TITLE value. Setting to a color or bold tag might improve readability.
HTML-TITLE-END
CHARACTER
After a SpeedScript frame title, Defaults to the null string (""), no text. Generally, if you change this value you must change the value of HTML-TITLE-BEGIN.

Output after the frame’s TITLE value.
IS-XML
LOGICAL
Returns whether an XML document was posted to the transaction server.
VALIDATE-XML
LOGICAL
Sets validation on parsing when an XML document is posted to the transaction server. The default is NO.
X-DOCUMENT
HANDLE
Contains the X-DOCUMENT handle of an XML document posted to the transaction server or the UNKNOWN value (?) if there isn’t one.

method

A method of the WEB-CONTEXT handle. The methods are listed in the table that follows:

Method
Return Type
Description
CONFIG-NAME ( )
CHARACTER
The WebSpeed service name. Intended for internal use only, this method is called by the get-config WebSpeed API function.
GET-CGI-LIST ( )
CHARACTER
List of CGI environment variables. Intended for internal use only, this method is called by the get-cgi WebSpeed API function.
GET-CGI-
VALUE ( )
CHARACTER
The value of a specified CGI environment variable. Intended for internal use only, this method is called by the get-cgi WebSpeed API function.
GET-CONFIG-VALUE ( )
CHARACTER
The value of parameters set in the WebSpeed configuration file. Intended for internal use only, this method is called by the get-config WebSpeed API function.
INCREMENT-
EXCLUSIVE-ID ( )
INTEGER
The amount by which to increment the exclusive ID of a Web request for state-aware agents. Do not access this method.
URL-DECODE (- )
CHARACTER
The string to decode. Intended for internal use only, this method is called by the url-decode WebSpeed API function.
URL-ENCODE (- )
CHARACTER
Characters to encode. Intended for internal use only, this method is called by the url-
encode WebSpeed API function.


Copyright © 2004 Progress Software Corporation
www.progress.com
Voice: (781) 280-4000
Fax: (781) 280-4095