System Info functions

These functions are used get information about the computer that is running the project (either server or client, depending on the function), as well as to change some project settings on that computer.

  • DBVersion
    DbVersion is a built-in scripting function that gets the version number of your project tags database.
  • GetAppHorizontalResolution
    Gets the default horizontal screen resolution (in pixels) of the project.
  • GetAppPath
    Returns the file path of the project folder.
  • GetAppVerticalResolution
    Gets the default vertical screen resolution (in pixels) of the project.
  • GetComputerIP
    Returns the first IP Address of the local computer.
  • GetComputerName
    Returns the local computer name.
  • GetCursorX
    Gets the X-coordinate of the mouse cursor on the screen.
  • GetCursorY
    Gets the Y-coordinate of the mouse cursor on the screen.
  • GetDisplayHorizontalResolution
    Gets the horizontal resolution (in pixels) of the display connected to the local station.
  • GetDisplayVerticalResolution
    Gets the vertical resolution (in pixels) of the display connected to the local station.
  • GetFreeMemoryCE
    Returns the free memory available in a Windows Embedded device.
  • GetHardKeyModel
    Returns the model name of your Hardkey.
  • GetHardKeySN
    Returns the serial number of the Hardkey.
  • GetIPAll
    Returns the number of IP Addresses assigned to the local station and stores the IP Addresses in a string array tag.
  • GetLicenseGracePeriod
    This function returns the number of minutes remaining until the license grace period expires.
  • GetMemoryCE
    Returns the total memory available in a Windows Embedded device.
  • GetNetMACID
    Gets the MAC ID unique code from the currently installed network adapter(s).
  • GetOS
    The function GetOS gets the operating system of the computer that hosts the project runtime server.
  • GetPerformanceMetric
    The GetPerformanceMetric function returns selected metrics for the graphics performance of your project runtime client.
  • GetPrivateProfileString
    Reads a specified parameter from an .ini file using the standard .ini format.
  • GetProductPath
    Gets the path to the program directory.
  • GetRegValue
    Gets a the value of a variable in the Windows registry.
  • GetRegValueType
    Gets the data type of the value of a variable in the Windows registry.
  • GetServerHostName
    Gets the host name of the project’s Server station.
  • GetTickCount
    Gets the current value of the clock ticks counter.
  • InfoAppAlrDir
    Returns the file path of the project’s Alarm sub-folder.
  • InfoAppHstDir
    Returns the file path of the project’s History sub-folder.
  • InfoDiskFree
    Returns free disk space on the local computer.
  • InfoResources
    Returns the local computer’s disposable resources.
  • IsActiveXReg
    Determines whether an ActiveX control is registered with the operating system.
  • IsAppChangedOnServer
    The function IsAppChangedOnServer checks whether the project files available on the server are newer than the files currently on the client.
  • NoInputTime
    Returns the time elapsed since the last keyboard action.
  • ProductVersion
    Returns the program version number.
  • RegSaveCE
    Saves the Windows Embedded system registry. This function will only work if the save registry capability is enabled in the Windows Embedded device image.
  • ReloadAppFromServer
    The function ReloadAppFromServer reloads the necessary project files from the server while maintaining the current state of the project on the client.
  • SaveAlarmFile
    Use this function to enable/disable the saving feature for alarm history and to set the path where the alarm history files must be handled.
  • SetAppAlarmPath
    Sets the Alarm path for the current project.
  • SetAppHstPath
    Sets the file path (directory) where Trend history files will be saved, in the proprietary format ( .HST ).
  • SetDateFormat
    Sets the format and separator for the date string.
  • SetKeyboardLanguage
    Sets the language of any Virtual Keyboards in the project.
  • SetRegValue
    Sets the value of a variable in the Windows registry.
  • SetWebConfig
    Configures the Web settings for the current project. The settings configured in the function are updated on the HTML files of the project.
  • SNMPGet
    Gets information from computers or network devices through the SNMP protocol.
  • SNMPSet
    Uses the Simple Network Management Protocol (SNMP) to set a value on a target computer of network device.
  • WritePrivateProfileString
    Writes a specified setting to the project viewer initialization file, using the standard .ini format.
InduSoft Web Studio -Technical Reference

System Info functions