## Help

### Request:/
Setting | Explanation | Default / Example | Data Type | Access R,W,A,D
--- | --- | --- | --- | ---
Argument/ | The decoded arguments supplied with the method (command) being invoked by the client. Each name and value pair is inserted into the list after having been unescaped. Under the HTTP protocol, this insertion of variables occurs regardless of whether METHOD=GET or METHOD=POST was specified for the form. |  | Text List | R
ArgumentText | The arguments as originally supplied with the method (command) being invoked by the client. If these arguments are compatible with the HTML Forms Interface, they are automatically decoded into the individual variable name and value pairs within the "Request:/Argument/" directory. | 23,52 | Text | R
AuthenticateType | The type of user authentication to perform. This variable is set by the User Authentication server hook. | none | Text | R,W
AuthenticateUser | The user name of the client user for authentication. This variable is set by the User Authentication server hook prior to verifying the user's password. | joe | Text | R,W
AuthenticatePassword | The password supplied by the client user for authentication. This variable is set by the User Authentication server hook. The user is not authorised to access the resource until the Access Control server hook agrees. | pass | Text | R,W
AutoHeaders | Set to TRUE to allow the server to generate a set of automatic default headers for the request reply. Set to FALSE to only reply with those headers that the server hooks specifically output. | Yes | Integer | R,W
BytesRead | The number of bytes received from the network so far during the current request. | 0 | Integer | R
BytesSent | The number of bytes sent to the network so far during the current request. This excludes the number of bytes currently sitting in the "Result" variable waiting to be sent. | 0 | Integer | R
Elapsed | The elapsed time, in seconds, since the current request started (that is, when the request was first received, before any processing). | 0 | Integer | R
ImmediateWrite | Set to TRUE to cause all output to be written immediately to the client without being buffered. This is useful for server-push scripts. Set to FALSE (the default) to cause the server and the network to automatically decide the optimal data transmission timing and sizing. | No | Integer | R,W
Method | The method (command) being invoked by the client. For example, "GET", "POST", "LS". To know the protocol in use, access the variable "Protocol". | GET | Text | R
NoCache | Set to TRUE to prevent the cache manager from trying to cache the response to this request. Default is FALSE, unless the header variable Expiry date is set to the current date and time. Some protocols will want to force this to FALSE for most types of requests. | No | Integer | R,W
ObjectType | The type of object referred to by the resource. This is set by the Resource Name Translation server hook. There is a standardised list of object types. | CGI | Integer | R,W
PathInfo | The directory path following the "Resource" name within the "VirtualResource". See also "PathTranslated". | /map/globe.map | Text | R,W
PathTranslated | This is the "PathInfo" variable after translation according to the document root directory. | /powerweb/docs/map/globe.map | Text | R,W
PostedText | The extra information included at the end of an HTTP POST request. For forms processing this means that the arguments are not decoded into the individual variable name and value pairs. For processing forms, the "Request/Argument/" directory is better suited. | Company=CompuSource | Text | R
Protocol | The protocol and version number used for this request. In contrast, the variable "Server/Protocol" variable gives simply the protocol name, without the version. This allows a server to handle multiple versions of the same protocol. | HTTP/1.0 | Text | R
Request | The first line of the request sent by the client. Variables "Protocol", "Method", "Resource", and "Arguments" break down the request into its constituent parts. | GET /index.html HTTP/1.0 | Text | R
Resource | The name of the resource after having been translated from its virtual path (contained in the "VirtualResource" variable) by the Resource Name Translation server hook. | /powerweb/docs/home.html | Text | R,W
Result | The result to be returned to the client. Interacts with the variable "ImmediateWrite" in that if it is set, the contents of the variable "Result" are cleared after every write. |  | Binary & Text | W,A
Status | The cross-protocol standardised status value which is transformed into a status code particular to the given protocol before returning to the client. If you know the protocol-specific status code, you can set "StatusCode" instead and leave "Status" set to 0. The standardised statuses are: 1 = No error, OK. 2 = Redirect the client to another server. 3 = Tell the client the data has not been modified. 4 = The request was not understood. 5 = The client has insufficient authorisation and should try again. 6 = The client is forbidden access, regardless of authorisation. 7 = The resource was not found. 8 = The server experienced an internal error. 9 = The server currently does not implement the feature requested. | 0 | Integer | R,W
StatusCode | The status code to return to the client. Protocols such as HTTP and FTP define a set of standardised status codes. You should be aware of these standard codes before setting this variable. If you do not know which code to use, you can use one of the cross-protocol standard status codes and set the variable "Status" appropriately. If both "Status" and "StatusCode" are defined, the value in "StatusCode" is used. | 200 | Integer | R,W
StatusText | The status text to return to the client. Follows the "Status" code in the reply to the client. Should be kept short. For the HTTP protocol, it is not normally shown to the user by the client's browser, because the "Status" code tells the browser what to do. | OK | Text | R,W,A
SubMethod | The sub-method of the command being invoked by the client. For example, with the HTTP protocol, the "GET" method has sub-methods "EXEC", "DOCUMENT", "INCLUDE", "INDEX" and "SCRIPT". | DOCUMENT | Text | R
VirtualResource | The name of the resource specified for the method (command) being invoked by the client. For example, "/index.html". This variable contains what is often called the URI in unescaped format. The URI is the portion of the URL following the host name and the port (if any) in the client request. See also the "Resource" variable. | /home.html | Text | R