INQUIRE TERMINAL

Syntax

ibmCics.inquireTerminal(new InquireTerminalOptions()
  .terminal(<Terminal>)
  [.servStatus(<ServStatus>)]
  [.userId(<UserId>)]
  [.accessMethod(<AccessMethod>)]
  [.acqStatus(<AcqStatus>)]
  [.altPageHeight(<AltPageHeight>)]
  [.altPageWidth(<AltPageWidth>)]
  [.altScreenHeight(<AltScreenHeight>)]
  [.altScreenWidth(<AltScreenWidth>)]
  [.correlId(<CorrelId>)]
  [.defPageHeight(<DefPageHeight>)]
  [.defPageWidth(<DefPageWidth>)]
  [.defScreenHeight(<DefScreenHeight>)]
  [.defScreenWidth(<DefScreenWidth>)]
  [.linkSystem(<LinkSystem>)]
  [.modeName(<ModeName>)]
  [.netName(<NetName>)]
  [.nqName(<NqName>)]
  [.operId(<OperId>)]
  [.pageHeight(<PageHeight>)]
  [.pageWidth(<PageWidth>)]
  [.remoteName(<RemoteName>)]
  [.remoteSysNet(<RemoteSysNet>)]
  [.remoteSystem(<RemoteSystem>)]
  [.screenHeight(<ScreenHeight>)]
  [.screenWidth(<ScreenWidth>)]
  [.signOnStatus(<SignOnStatus>)]
  [.taskId(<TaskId>)]
  [.termModel(<TermModel>)]
  [.termStatus(<TermStatus>)]
  [.transaction(<Transaction>)]
  [.userArea(<UserArea>)]
  [.userAreaLength(<UserAreaLength>)]
  [.userName(<UserName>)]
  [.noHandle(true)]
);

Parameters

<Terminal>

The name of the terminal.

<ServStatus>

Returns the status of the terminal, in AMT this will return the value for 'INSERVICE'.

<UserId>

Returns the user ID using the terminal.

<AccessMethod>

Not currently used in AMT, returns 0.

<AcqStatus>

Not currently used in AMT, returns 0.

<AltPageHeight>

Not currently used in AMT, returns 0.

<AltPageWidth>

Not currently used in AMT, returns 0.

<AltScreenHeight>

Not currently used in AMT, returns 0.

<AltScreenWidth>

Not currently used in AMT, returns 0.

<CorrelId>

Not currently used in AMT, returns 0.

<DefPageHeight>

Not currently used in AMT, returns 0.

<DefPageWidth>

Not currently used in AMT, returns 0.

<DefScreenHeight>

Not currently used in AMT, returns 0.

<DefScreenWidth>

Not currently used in AMT, returns 0.

<LinkSystem>

Not currently used in AMT, returns 0.

<ModeName>

Not currently used in AMT, returns 0.

<NetName>

Not currently used in AMT, returns 0.

<NqName>

Not currently used in AMT, returns 0.

<OperId>

Not currently used in AMT, returns 0.

<PageHeight>

Not currently used in AMT, returns 0.

<PageWidth>

Not currently used in AMT, returns 0.

<RemoteName>

Not currently used in AMT, returns 0.

<RemoteSysNet>

Not currently used in AMT, returns 0.

<RemoteSystem>

Not currently used in AMT, returns 0.

<ScreenHeight>

Not currently used in AMT, returns 0.

<ScreenWidth>

Not currently used in AMT, returns 0.

<SignOnStatus>

Not currently used in AMT, returns 0.

<TaskId>

Not currently used in AMT, returns 0.

<TermModel>

Not currently used in AMT, returns 0.

<TermStatus>

Not currently used in AMT, returns 0.

<Transaction>

Not currently used in AMT, returns 0.

<UserArea>

Not currently used in AMT, returns 0.

<UserAreaLength>

Not currently used in AMT, returns 0.

<UserName>

Not currently used in AMT, returns 0.

noHandle

Optional Boolean. If set to true, exceptions created by this command will be ignored.

Examples

EXEC CICS
    INQUIRE TERMINAL (WS-TERMINAL)
        SERVSTATUS (WS-STATUS)
        USERID (WS-USER)
END-EXEC.

ibmCics.inquireTerminal(new InquireTerminalOptions()
  .terminal(locDef.ws_Terminal)
  .servStatus(locDef.ws_Status)
  .userId(locDef.ws_User)
);