External Interfaces > RealWeb > RealWeb API > System Routines > RW_GET_PARAM

Comment on this topic

Documentation Comments

Use this form to comment on this topic. You can also provide any general observations about the Online Documentation, or request that additional information be added in a future release.

Reality V15.0 ()

RW_GET_PARAM (RealWeb) (rw_get_param.htm)

To

Reality

Version

Topic

Submitted by

Company

Location

Email address

Comment

 

 

RW_GET_PARAM


Purpose

Returns the value of a RealWeb parameter. Parameters are of two kinds:

Syntax

RW_GET_PARAM(Param, vResult)

Parameters

Param The name of the parameter to retrieve.

vResult A variable in which to return the value of the parameter.

Comments

Internal RealWeb Parameters

The following internal RealWeb parameters are available:

__script The root path to the reality servlet. Normally set to "/servlet/reality".

__section The name of the section being used in the configuration file.

__pathinfo The name of the called subroutine.

__page The path component that follows the name of the subroutine. For example, if the full URLis "http://localhost/servlet/reality/persistent/HOTEL/room/17", the __pathinfo parameter will contain "HOTEL" and __page will contain "room/17".

__isurl The absolute URLof the Reality item server (realityis) on the current web server. Used when downloading images directly from the database.

__url The full url used to access this subroutine.

For example, if the URL of the current subroutine is

http://www.foo.com/servlet/reality/hotelConnect/HOTEL/room

The internal parameters will contain the following:

__script "/servlet/reality"

__section "hotelConnect"

__pathinfo "HOTEL"

__page "room"

__isurl "/servlet/realityis/test"

__url "http://www.foo.com/servlet/reality/hotelConnect/HOTEL/room"

Search String Parameters

Parameters can be added to a URL as a search (query) string; that is, by appending a question mark (?) to the URL path (see The Structure of a URL), followed by a list of name/value pairs separated by ampersands (&). An equals sign separates the name and the value in each name/value pair. For example, in the URL:

http://www.foo.com/servlet/reality/hotelConnect/HOTEL/room?number=21&location=annex

The parameters "number" and "location" have the values 21 and "annex" respectively.

When a form is submitted, any parameters are automatically passed in this format.

Note: RealWeb uses standard encoding for parameters added to a URL.

RealityV15.0Comment on this topic