Request Commands

HostExplorer Programming

Request Commands

You can request the following items from a Session topic:

Columns—Returns the number of columns in the current presentation space.

Cursor—Returns the current cursor location in the presentation space. 1 is the first position.

Emulator—Returns the window handle of the window displaying the presentation space.

File Transfer— Returns the short name of the presentation space and either 0 if no transfer is occurring or 1 if a transfer is occurring. For additional information, see the File Transfer example. Click for more information

Keyboard—Returns the status of the 3270 keyboard. Valid return values are Clear and Locked.

Model—Returns the 3270 model for the presentation space. Valid values are 2, 3, 4, and 5.

OIA—Returns the operator information area (OIA) in ASCII format.

Power—Always returns “On”.

Profile Name—Returns the name of the profile used for the presentation space; for example, DEFAULT.

Rows—Returns the number of rows in the current presentation space.

Search—Returns the position of the search string in the presentation space (PS). The search string is defined using the POKE command.

PS—Returns the entire contents of the PS. The entire space is returned as one string. Nulls are converted to blanks. Therefore, if you are using a Model 2 terminal (24x80), a string of 1920 bytes is returned.

Pnnnn[F/Lmmm]—Returns a portion of the PS. Nulls are converted to blanks. For additional information, refer to the Pnnnn[F/Lmmm] example. Click for more information

Fnn[U/P]—Returns the contents of the field specified. Nulls are converted to blanks. For additional information, refer to the Fnn example. Click for more information

Rnn—Returns the contents of the specified row. Nulls are converted to blanks.

R2—Returns the contents of the second row in the presentation space. The length is dependent on which 3270 model you are using. Models 2, 3, and 4 return 80 characters, whereas a model 5 returns 132 characters.


Related Topics

Advise Commands

Execute Commands

Poke Commands