Page (HttpRequest property)

From m204wiki
Revision as of 21:12, 6 March 2012 by Dme (talk | contribs) (→‎Syntax terms)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Relative page path (HttpRequest class)

The Page settable property identifies a page path that is relative to the site root. Such a page, or document, is what follows the host and any port number in a URL. You set the page for an HTTP request by assigning a value to Page, and you fetch its value by referencing it without any parameters.

Syntax

%currentString = httpRequest:Page httpRequest:Page = newString

Syntax terms

%currentString A string or Longstring variable for the assignment of the current value of Page.
httpRequest A previously defined and instantiated HttpRequest object.
newString A string expression identifying the page to fetch. It does not include a host name. If left unset, it defaults to the slash character (/), the root page for the host website. The maximum length of the string is 1030, as of Sirius Mods version 8.0; previously it was 255.

Example

To set the page /links.html as in:

http://foo.com:123/links.html

You would use:

%httpreq:Page = '/links.html'

See also