Tags:
create new tag
view all tags

.CLIENT GET CONSTANT

This subroutine returns the value of a client constant.


Usage:

      PASS         <client_value>             FIELD            SHARE? Y
      PASS         <client_name>              FIELD            SHARE? N
      GOSUB    --- .CLIENT GET CONSTANT
      *        Check for errors
      IF       --- .CLIENT GET CONSTANT       NE

Description:

This subroutine returns the value of a client constant. All parameters are required, if any are missing the subroutine will CANCEL.

<client_value> will contain the value of the client constant, if it is found (Required). This must be PASSed with Share "Y" to return the value.

<client_name> is the name of the client constant for which you want the value (Required). This is case sensitive, see the list below.

If the field you passed is too short to contain the data, --- .CLIENT GET CONSTANT will be set to "Data was truncated". If the client constant does not exist, --- .CLIENT GET CONSTANT will be set to "Const. name not found".

The list of client constants you can query varies from release to release. To see the current constants, from the main Appx menu, choose System Administration/System Setup/Version Info from the pull down menu, then click the Environment Variables button. Everything that begins with 'client.' can be queried with this subroutine. Do not include the leading 'client.' in <client_name>, eg, to get the value of 'client.os.name' you would pass 'os.name'. To get the value of an environment variable, see .ENV GET ENV VARIABLE.

NOTE: The values retrieved are not coming directly from the client. The APPX engine stores them during the initial startup of the client, and does not update them if they change while the client is running. Thus these constant variables will NOT reflect changes made to them after startup.

Here is a list of client constants available as of Release 5.1:

  • client.client.address
  • client.client.port
  • client.client.version
  • client.client.version.num
  • client.clientHome
  • client.display.0.height
  • client.display.0.width
  • client.display.0.x
  • client.display.0.y
  • client.display.count
  • client.file.separator
  • client.java.home
  • client.java.io.tmpdir
  • client.java.vm.version
  • client.line.separator
  • client.os.arch
  • client.os.name
  • client.os.version
  • client.path.separator
  • client.pref.SSLAnonAllowed
  • client.pref.SSLHandshakeTimeout
  • client.pref.SSLMismatchAllowed
  • client.pref.SSLMode
  • client.pref.SSLSelfSignedAllow
  • client.pref.allowAquaButtons
  • client.pref.allowXpTheme
  • client.pref.appxDoubleClick
  • client.pref.arrowScrollEditor
  • client.pref.autoDeleteTimer
  • client.pref.autoFontScaling
  • client.pref.autoSelect
  • client.pref.autoTabOut
  • client.pref.baseFontName
  • client.pref.baseTilingMode
  • client.pref.baseWallpaper1
  • client.pref.baseWallpaper2
  • client.pref.baseWallpaper3
  • client.pref.baseWallpaper4
  • client.pref.baseWallpaper5
  • client.pref.busyRepaintTimer
  • client.pref.cachePath
  • client.pref.cacheRoot
  • client.pref.caretColor
  • client.pref.characterEncoding
  • client.pref.clientHome
  • client.pref.colorAppletBg
  • client.pref.colorBoldFg
  • client.pref.colorButtonBg
  • client.pref.colorButtonFg
  • client.pref.colorEditBg
  • client.pref.colorFrameBg
  • client.pref.colorFrameFg
  • client.pref.colorScrollSelectActive
  • client.pref.colorScrollSelectOther
  • client.pref.colorStdBg
  • client.pref.colorStdFg
  • client.pref.colorWindowBg
  • client.pref.commandShell
  • client.pref.connectMode
  • client.pref.dataCachePath
  • client.pref.debugLogLevel
  • client.pref.debugNotifyLevel
  • client.pref.dockingScrollbar
  • client.pref.editInsetBottom
  • client.pref.editInsetLeft
  • client.pref.editInsetRight
  • client.pref.editInsetTop
  • client.pref.editorCellGridColor
  • client.pref.editorForceSize
  • client.pref.editorInchGridColor
  • client.pref.embedApplet
  • client.pref.endMappedToCtrlE
  • client.pref.enginePath
  • client.pref.guiInterface
  • client.pref.guiLook
  • client.pref.hidePrefsMenuItem
  • client.pref.hideStaticClientMenus
  • client.pref.initialFontSize
  • client.pref.lastHost
  • client.pref.lastIniFile
  • client.pref.lastPath
  • client.pref.lastPid
  • client.pref.lastPort
  • client.pref.lastTab
  • client.pref.lastUseSSO
  • client.pref.lastUser
  • client.pref.logBitsRecv
  • client.pref.logBitsSent
  • client.pref.logClassCreation
  • client.pref.logConsoleToFile
  • client.pref.logFileTransfers
  • client.pref.logGetFieldList
  • client.pref.logGetFileList
  • client.pref.logKeyboardEventStack
  • client.pref.logKeyboardEvents
  • client.pref.logObjectEvents
  • client.pref.logRawEventData
  • client.pref.logRawWidgetData
  • client.pref.logServerRequests
  • client.pref.logTokenScanList
  • client.pref.logTopBoxTitle
  • client.pref.loggingEnabled
  • client.pref.loginPositionX
  • client.pref.loginPositionY
  • client.pref.mapEndKey
  • client.pref.mapOptionKey
  • client.pref.mapTabKey
  • client.pref.memoryCheckTimer
  • client.pref.nationalEncoding
  • client.pref.netcardLockupFix
  • client.pref.networkEncoding
  • client.pref.pdfReportViewer
  • client.pref.printCachePath
  • client.pref.printColsPerInch
  • client.pref.printRowsPerInch
  • client.pref.profileName
  • client.pref.rawEncoding
  • client.pref.remoteHost
  • client.pref.remotePassword
  • client.pref.remotePort
  • client.pref.remoteUser
  • client.pref.repaintLevel
  • client.pref.resourceCachePath
  • client.pref.runApplication
  • client.pref.runDatabase
  • client.pref.runProcess
  • client.pref.runProcessType
  • client.pref.scalingQuality
  • client.pref.scanTooltip
  • client.pref.screenAspect
  • client.pref.screenColumns
  • client.pref.screenRows
  • client.pref.showButtonFocus
  • client.pref.showDateScans
  • client.pref.showErrorDialogs
  • client.pref.showGridlines
  • client.pref.showMenubar
  • client.pref.showMessageDialogs
  • client.pref.showOptionNumbers
  • client.pref.showOptionsTab
  • client.pref.showScanButtons
  • client.pref.showScrollbar
  • client.pref.showStatusbar
  • client.pref.showToolbar
  • client.pref.showWarningDialogs
  • client.pref.startX
  • client.pref.startY
  • client.pref.startupWallMode
  • client.pref.startupWallpaper
  • client.pref.tcpNoDelay
  • client.pref.textReverseEnterKey
  • client.pref.themeDir
  • client.pref.themeHome
  • client.pref.themeName
  • client.pref.tokenCachePath
  • client.pref.toolbarIconSize
  • client.pref.toolbarStyle
  • client.pref.txtReportViewer
  • client.pref.ucode32Encoding
  • client.pref.useSSO
  • client.pref.userClientRoot
  • client.pref.userData
  • client.pref.userHome
  • client.pref.widgetFontAdjust
  • client.pref.windowTitle
  • client.server.address
  • client.server.port
  • client.sun.cpu.endian
  • client.user.dir
  • client.user.home
  • client.user.language
  • client.user.name
Remember, these are case sensitive and do not pass the leading 'client.' in the <client_name> field.

Comments:

Read what other users have said about this page or add your own comments.

-- JeffPrentice - 2012-05-15

This technique (example) does not work in 5.0.4.

-- JeffPrentice - 2012-05-15

-- JeffPrentice - 2012-05-15

does not work in 5.0.4 windows....

-- JeffPrentice - 2012-05-15

-- JeanNeron - 2012-02-01

Edit | Attach | Watch | Print version | History: r6 < r5 < r4 < r3 < r2 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r6 - 2012-10-26 - JeanNeron
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 2008-2019 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback