GetURLParams
- Last UpdatedOct 29, 2026
- 1 minute read
GetURLParams is a built-in function that gets the list of parameters in the current URL in the browser.
|
Function |
Group |
Execution |
String Exp. |
Windows |
Windows Embedded |
IoT View |
Thin Clients |
Mobile Access |
|---|---|---|---|---|---|---|---|---|
|
GetURLParams |
Graphic |
Synchronous |
No |
Not supported |
Not supported |
Not supported |
Not supported |
Supported |
Syntax
GetURLParams()
GetURLParams ( )
This function takes no parameters.
Return value
This function returns a string value that is equal to the query string in the current URL in the browser.
Notes
This function is only supported by Mobile Access because it is designed to get the list of parameters that were used to link directly to a project screen in Mobile Access. For more information, see Link directly to a project screen or screen group.
When this function is executed, it automatically retrieves the current URL from the browser and then parses it to get the query string. In other words, it returns everything that follows the delimiter character (? or #) that indicates the start of the query string. The query string comprises one or more parameters in field=value format, and those parameters are separated by ampersands (&).
You can use other built-in functions like StrGetElement to further parse the list of parameters.
Examples
When the current URL in the browser is…
http://localhost/#screen=screen1&guestuser=1
…this function returns the following string value:
screen=screen1&guestuser=1