GET

LANSA Integrator

GET

The client application may issue the GET command to receive attributes associated with the aXes terminal session into named client program variables.

Note: You usually need to specify SERVICE_EXCHANGE(*FIELD) in the command string in order to receive the return values into your client program variables named on keywords beginning with RTNxxx. Refer to 5.41.2 Using the AxesTerminalService for more information.

 

                                                          Optional

 

 GET ------------- RTNCURSORROW ---- field-name ----------------->

  

               >-- RTNCURSORCOL ---- field-name ----------------->

  

               >-- RTNDEVICENAME --- field-name ----------------->

  

               >-- RTNJOBUSER ------ field-name ----------------->

  

               >-- RTNJOBNUMBER ---- field-name ----------------->

  

               >-- RTNSCREENWIDTH -- field-name ----------------->

  

               >-- RTNSCREENHEIGHT - field-name ----------------->

  

               >-- RTNSYSTEMNAME --- field-name ----------------->

  

               >-- RTNSIG ---------- field-name ----------------->

  

               >-- RTNSCREEN ------- field-name -----------------|

 

Keywords

RTNCURSORROW

The name of a field exchanged between your client program and the JSM that will receive the row number component of the current screen cursor position.

RTNCURSORCOL

The name of a field exchanged between your client program and the JSM that will receive the column number component of the current screen cursor position.

RTNDEVICENAME

The name of a field exchanged between your client program and the JSM that will receive the 5250 device name used by the current aXes terminal session.

RTNJOBUSER

The name of a field exchanged between your client program and the JSM that will receive the user name portion of the i/OS job name for the current aXes terminal session.

RTNJOBNUMBER

The name of a field exchanged between your client program and the JSM that will receive the job number portion of the i/OS job name for the current aXes terminal session.

RTNSCREENWIDTH

The name of a field exchanged between your client program and the JSM that will receive the current screen width for the aXes terminal session. Note that this value refers to the screen currently displayed, not maximum device capabilities.

RTNSCREENHEIGHT

The name of a field exchanged between your client program and the JSM that will receive the current screen height for the aXes terminal session. Note that this value refers to the screen currently displayed, not maximum device capabilities.

RTNSYSTEMNAME

The name of a field exchanged between your client program and the JSM that will receive the i/OS system name for the current aXes terminal session.

RTNSIG

The name of a field exchanged between your client program and the JSM that will receive the screen signature of the screen that is present.

RTNSCREEN

The name of a field exchanged between your client program and the JSM that will receive the name of the screen that is present. The screen name is the user-defined name if an aXes project name was specified on the CONNECT command and a name was assigned to the screen. Otherwise the screen signature is returned.

 

Examples

RDML Example:

DEFINE FIELD(#MYJOBUSR) REFFLD(#STD_TEXT)

DEFINE FIELD(#MYJOBNUM) REFFLD(#STD_TEXT)

CHANGE FIELD(#JSMCMD) TO('GET RTNJOBUSER(MYJOBUSR) RTNJOBNUMBER(MYJOBNUM) SERVICE_EXCHANGE(*FIELD)'

USE BUILTIN(JSM_COMMAND) WITH_ARGS(#JSMCMD) TO_GET(#JSMSTS #JSMMSG)

 

RDMLX Example:

define field(#myjobusr) reffld(#std_text)

define field(#myjobnum) reffld(#std_text)

#jsmcommand := 'GET RTNJOBUSER(MYJOBUSR) RTNJOBNUMBER(MYJOBNUM) SERVICE_EXCHANGE(*FIELD)'

use builtin(jsmx_command) with_args(#jsmhandle #jsmcommand) to_get(#jsmstatus #jsmmessage)