SysEnvironment (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / WLanguage functions / Standard functions / Windows functions / System functions

Search
Equivalence
Environment variables in a WEBDEV site

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

SysEnvironment (Function)

In french: SysEnvironnement

Returns the environment variables of the operating system for the current computer.

Note: To view and/or modify the environment variables in the current computer, open the Control Panel and click the "System" icon.

Example

// Get all the environment variables of the operating system
ResEnvironment = SysEnvironment()

// Get the environment variables of the operating system
Trace(SysEnvironment("homepath"))
// returns for example: 
// homepath=\Users\doc

Syntax

<Result> = SysEnvironment([<Environment variable>])

<Result>: Character string

Full environment of current computer (or server) if no <Environment variable> is specified. The environment lines are separated by CR characters.
Environment line whose first word corresponds to the <Environment variable> parameter.
Empty string ("") if a problem occurred.

<Environment variable>: Optional character string

Variable to find in the environment of the current computer ("PATH" or "USERNAME" for instance).

Remarks

The search on the <Environment variable> parameter is generic. For example, SysEnvironment("PR") returns the line corresponding to the prompt (if it exists in the environment).
If several lines match the search, only the first one is returned.

Equivalence

SysEnvironment returns the same result as the SET command of the DOS command line.

Environment variables in a WEBDEV site

The environment variables returned correspond to the environment variables of the operating system of the server.

The CGI protocol defines a set of default variables:

Variable name	Content

DOCUMENT_ROOT	The root directory for the documents of the Web server.
HTTP_COOKIE	The value of the cookies saved by the server. Note: To manipulate cookies, it is recommended to use CookieRead and CookieWrite.
HTTP_HOST	The server name.
HTTP_REFERER	The URL of the page that directed to the current page.
HTTP_USER_AGENT	The description of the browser used.
HTTPS	This variable will have the value "on" if the HTTPS protocol was used. Otherwise, it is not defined.
QUERY_STRING	The URL requested by the client machine before interpretation by the server. This is the "raw" request.
REMOTE_ADDR	The IP address of the browser. We recommend that you use BrowserIPAddress.
REMOTE_HOST	The name of the client computer (or its IP address if the name could not be resolved or if the resolution feature is disabled in the Web server).
REMOTE_PORT	The port used by the client computer to connect to the Web server.
REMOTE_USER	The username provided by the client computer (used for pages protected by a HTTP authentication mechanism).
REQUEST_METHOD	The method used to make the HTTP request: "GET" or "POST".
REQUEST_URI	The URI requested by the client computer after interpretation by the server.
SCRIPT_FILENAME	The full path of the program being run on the web server.
SCRIPT_NAME	The portion of the SCRIPT_FILENAME variable relative to the DOCUMENT_ROOT variable.
SERVER_ADMIN	The contact information of the server administrator (his email address in most cases).
SERVER_NAME	The host header name of the server.
SERVER_PORT	The port on which the Web server has been contacted.
SERVER_SOFTWARE	The information string of the Web server (if it is provided).

Component: wd300std.dll