Class wwRequest

The wwRequest class' purpose is to allow your programs to receive information from the web server and the HTML page that generated a Web request. It retrieves Form and QueryString variables, Cookies and ServerVariables - it basically acts as your input source for a request.

Class Members

Member		Description
	Form	Retrieves an HTML form variable posted to the Web server. Form variables are the primary interface for a Web client to communicate with a Web server and POST variables are the most common. Everytime… o.Form(lcPostKey,llNullIfNotFound)
	FormOrValue	Returns a value first by checking the Form variable in the Request buffer, and if it doesn't exist (or the request isn't POSTBACK) returning the value. Use this function to get data depending on… o.FormOrValue(lcFormKey, lvValue)
	FormChecked	A form helper function that simplifies setting HTML listvalues to server PostBack values with expressions. This function returns `checked="checked"` when the form value matches the provided value or… o.FormChecked(lcFormKey, lcValue, lcModelValue)
	FormDate	Returns a date from a form variable by trying to convert the string date input to a date time value. Supports ISO date conversion for native `type="date"` and `type="datetime-local"` inputs as well… o.FormDate(lcFormKey, llNullIfNotFound)
	FormDateOrValue	Returns a form variable as a date on post back operations or returns the specified value on a non-POST operation or if the value is not part of the POST buffer. o.FormDateOrValue(lcFormKey, ltValue)
	FormSelected	A form helper function that simplifies setting HTML listvalues to server PostBack values with expressions. This function returns `checked="checked"` when the form value matches the provided… o.FormSelected(lcFormKey, lcValue, lcModelValue)
	GetFormVarCollection	Retrieves a collection of all the form variables keys and values in the Request.Form() collection so you can iterate the variables. The collection contains an object that has `Key` and `Value`… o.GetFormVarCollection(tcPrefix)
	GetFormMultipleCollection	This method retrieves multiselect Request form variables into a collection of string values. Multi-select values can come from Multi-select lists, drop downs or from radio buttons. o.GetFormMultipleCollection(tcVarname)
	GetUrlEncodedKeyCollection	Allows enumerating and parsing of any Url Encoded list of values into a collection of `Key` and `Value` property objects. Allows retrieving: * All Form Variables (`cFormVars`) * All QueryString… o.GetUrlEncodedKeyCollection(lcVars, lcPrefix)
	GetRawFormData	Returns all of the form data in raw form. Use this method to retrieve the POSTed data in its entirety which is a common scenario if you are dealing XML or binary data posted from a thick client.… o.GetRawFormData()
	InitializeRequest	This method is responsible for setting up the Request object on each hit by passing in the POST data in some format and making it available to the specific Get methods. This method is fired on every… o.initializerequest(lcPostData, lcTempPath)
	IsChecked	Determines whether a checkbox or radio button has been checked. Realistically this method just returns the same value as IsFormVar() but it's cleaner and describes the intent more clearly. o.wwrequest.IsChecked(lcFormVar)
	IsFormVar	Checks to see if a form variable exists in the request POST buffer. This method returns .T. if the key exists even if the value is blank. It will only return .F. if the key doesn't exist at all. If… o.IsFormVar(lcKey)
	IsPostback	Determines whether the current request is being sent via an HTTP POST operation. Useful when checking for first time display or submit handling of requests. o.IsPostback()
	QueryString	Returns either a single key's value from a query string, or the entire query string as a whole. Query strings are used to pass small bits of request information on the URL by using keys following… o.QueryString(lvKey)
	GetQueryStringMultipleCollection	Returns either a collection of matching key values from a query string. Use this is if you have multi-select values from a form, or you simply need to pass multiple values for a single key to a URL.… o.GetQueryStringMultipleCollection(lvKey)
	Params	Returns a value by checking FormVars, QueryString, Session and ViewState (in that order) for a matching key and returning the value. This function is useful if you store values in the QueryString or… o.Params(lcKey)
	ServerVariables	Retrieves a server variable from the request data. Server variables provide information about the current request including info about the client application (browser, IP Address), the current… o.servervariables(lcKey)
	SetKey	Sets a form variable to the specified value from the existing POST data block. This method is useful for operations where the program needs to make changes to existing POST variable provided by the… o.setkey(lcKey, lcValue)
	FormVarsToObject	Parses an object and pulls form variables from the request buffer by matching the property names to the request variables. > In v7.0 and later, this function replaces the `.aFormVars()` method of… o.FormVarsToObject(loObject,lcPrefix,lcExcludedProperties)
	GetApplicationPath	Returns the physical OS path of the virtual directory of this Web Server application. In short it maps the virtual directory defined in IIS to a physical path. Can be used as a 'base url' for Web… o.GetApplicationPath()
	GetAuthenticatedUser	Returns the name of a user if he has been authenticated by the Web server. This variable gets set and stays set once a user has entered a valid username into the browser dialog box when prompted. The… o.getauthenticateduser(lnMode)
	GetBrowser	Returns the client's browser display name. The names tend to be verbose and do not lend themselves well for parsing and consistent values. For example IE 5 returns: Mozilla/4.0 (compatible; MSIE… o.getbrowser()**
	GetCookie	Returns an HTTP Cookie that was previously set. HTTP cookies allow keeping state by keeping a persistent variable on the user's browser. Cookies are sent along in each HTTP request and appear as a… o.getcookie(lcCookie)
	GetCurrentUrl	Returns the current URL. This method tries to reconstruct the current URL by looking all the component pieces available in the request information. Most of the time this is correct, but in some… o.getcurrenturl(llHTTPS)
	GetExecutablePath	Returns the logical, Web relative path to the DLL or script. http://www.west-wind.com/wconect/noceode.wc returns: /wconnect/nocde.wc The path is always in Web format with forward slashes and is… o.getexecutablepath()
	GetExtraHeader	Returns a custom HTTP Header sent from the client. Extra Headers are custom headers posted by client applications to send special processing instructions to the server. For example, SOAP includes a… o.GetExtraHeader(lcHeader)
	GetFormMultiple	This method retrieves multiselect HTML form variables from the CGI content file into an array. Multiselect variables can be returned when using scrolling HTML lists with the SELECT MULTIPE option or… o.getformmultiple(@taVars,tcVarname)
	GetHttpVerb	Returns the HTTP verb of the request. Frequently used in REST requests to determine how a resource is to be accessed. o.GetHttpVerb()
	GetIPAddress	Returns the client's IP Address. o.getipaddress()
	GetLogicalPath	Returns the web server relative path of the current request. For example: http://www.west-wind.com/wconect/Testpage.wc returns: /wconnect/Testpage.wc The path is always in Web format with… o.getlogicalpath(llProxiedPaths)
	GetLocale	Returns the currently active language in the browser if available. The value is returned from the ACCEPT_LANGUAGES header and this method returns the first value in this list. The format of this… o.GetLocale(@laLanguages)
	GetMultipartFile	Retrieves a single file uploaded with HTTP file upload into a binary string. > #### @icon-info-circle Use GetMultipartFiles instead > We recommend you use… o.GetMultipartFile(lcKey, @lcFileName)
	GetMultipartFiles	Retrieves a collection of files that match the given form key. This method supports receiving a single file or multiple files from an `` form control or from an AJAX upload. This method can support… o.GetMultipartFiles(lcKey)
	GetMultipartFormVar	Retrieves a multipart form variable from the request buffer. Multipart form variables are submitted on the client side by specifiying an encoding type of "multipart/form-data". Multipart forms are… o.GetMultipartFormVar(lcKey)
	GetRequestId	Returns the unique Request ID for the currently executing request. This ID is generated in the ISAPI extension and passed to your code via the REQUESTID server variable. This ID is logged in the Web… o.GetRequestId()
	GetPhysicalPath	Returns the physical path to a script mapped page or an executable DLL file. The physical path is a great tool for capturing the system specific path of script mapped pages, so you can capture the… o.getphysicalpath()
	GetPreviousUrl	Returns the referring URL for the page when available. Essentially this returns the previous URL that was clicked or navigated to bring you to the current page. This value may be blank if the… o.GetReferrer()
	GetRelativeSecureLink	This method allows you to easily create a secure link simply by specifying a relative link like any other link. The problem is that switching between HTTP and HTTPS requires a fully qualified URL… o.GetRelativeSecureLink(lcLink,llNonSecure)
	GetRoutingInfo	Returns routing info and Path Segments when dealing with extensionless URLs. Method returns an object with the following properties: * lIsRouted If true means this request was re-rewritten by… o.GetRoutingInfo()
	GetServerName	Returns the server's domain or IP address. Note that this value returns only the server portion of the current URL. o.GetServerName()
	GetServerSoftware	Returns the software that's running the Web server. o.getserversoftware()
	GetVirtualPath	Retrieves the virtual path of the current request. The value is provided with leading and trailing forward slashes. Example: /wconnect/ Web Connection has to deduce this value and it is… o.GetVirtualPath()
	GetWCIniValue	Retrieves a value from the Web Connection ISAPI/CGI configuration file. Most useful for retrieving the AdminUser value. o.getwcinivalue(lcKey, lcSection)
	islinksecure	Checks to see if the user is coming in over the SSL port. o.IsLinkSecure(lcSecurePort)
	getclientcertificate	Returns the contents of a client Certificate's Subject key. This information contains the info about the client. The following information is provided: ClientCert Flags=1 ClientCert… o.getclientcertificate(lcSubKey)
	UnbindFormVars	Unbinds the `Request.Form` object into a passed in FoxPro object, by mapping the properties of the object to form variable names. The method then uses `Request.Form(field-name)` to retrieve the value… o.UnbindFormVars(loObject, lcPrefix, lcExcludedProperties)
	lUtf8Encoding	If .T. causes Request.Form() and Request.QueryString() to UTF-8 decode the returned values. Utf-8 encoding is off by default for pages, but if you switch the browser into UTF-8 mode or use AJAX and…
	nPostMode	Request property that gets set by InitializeRequest and determines what kind of Form submission is occurring. 0 - Not a POST operation 1 - UrlEncoded POST (standard HTML forms) 2 - Multipart Forms…
	cFormVars	This property holds the raw POST buffer that the HTTP client submitted. The format of this buffer depends on the mechanism the client used to send the data to the server. Several modes are common…
	cpathoverride	Actual location of the Temporary path. This path is used to override any 'physical' paths to point to the network path instead.
	cServerVars	This property holds the raw Server variables returned from the Web Connection DLL. This data is URLEncoded and was created by Web Connection on the fly. Every call to ServerVariables accesses this…
	lusexmlformvars	If .T. Request.Form retrieves variables from an XML document contained in the form buffer rather than regular post variables. This powerful feature allows you to transparently accept input from XML…
	oapi	Internal wwAPI object. The object is not protected to allow persistent access to an API object through the Request.oAPI member.
	oxml	Internal reference to a wwXML object. This object is not protected and can be treated as a 'global' reference to a wwXML object accessible through wwRequest.oXML.

Assembly: wwRequest.prg

Class wwRequest

Class Members

See also