Technical Reference Manual - InduSoft

Appendix: Built-in Scripting Language
Examples
Tag Name
Expression
Tag DialError( 0, "Office DialUp" )
Tag
DialError( 1, "USRobotics_SportsterFaxModem", "StatusMessage",
second )
Tag DialError( 2, "DirectDial", "DialupError" )
See also: FindModem()
DialGetClientIP
This function gets the IP address of a Remote Access Service (RAS) client station.
Function Group Execution Windows Embedded Thin Client
DialGetClientIPDial-up Synchronous Supported (see note) Supported Supported
Syntax
DialGetClientIP({ numType | 0 | 1 | 2 },strPhoneBookOrModem,"tagClientIP"{ | ,optTagRefresh })
numType
The type of information specified by strPhoneBookOrModem: 0 is a Phonebook Name, 1 is a
Modem Name, and 2 is a Direct Connection Name.
strPhoneBookOrModem
tagClientIP
optTagRefresh
The Phonebook Name, Modem Name, or Direct Connection Name used to make the connection.
The name of a String tag that will receive the IP address.
Note: The tag name must be enclosed in quotes, as shown in the syntax
diagram, or else the project will try to get the value of the named tag.
The name of a tag that, whenever the value of the tag changes, will trigger the function to
refresh its returned value.
Also, this parameter is optional but you must include it when you configure the function on an
object animation such as Text Data Link or Position.
Returned value
This function returns the following possible values:
Value
Description
-5 DialGetClientIP was not found in IndRAS.dll.
-4 Invalid type; check numType.
-3 Incorrect number of parameters.
-2 DialStatus was not found in IndRAS.dll.
-1 IndRAS.dll was not loaded.
n
Status code returned by DialStatus.
This is the value returned by the function itself. The IP address is written to the tag specified by tagClientIP.
Page 716
InduSoft Web Studio