Start Data Stream Translation Session (QD0STRTS) API

  Required Parameter Group:

1 Translation session handle Output Char(16)
2 Display device name Input Char(10)
3 Default screen size Input Char(10)
4 Alternate screen size Input Char(10)
5 Error code I/O Char(*)

  Threadsafe: No

The Start Data Stream Translation Session (QD0STRTS) API initiates a session for data stream translation. Your application can start as many translation sessions as you need.


Authorities and Locks

Device Authority
The user must have at least *USE authority to the device specified in the display device name parameter.

Required Parameter Group

Translation session handle
OUTPUT; CHAR(16)

The name of the translation session. This name is supplied to your application so that you can keep track of a particular session. It is also required that you pass this name to the other data stream APIs.

Display device name
INPUT; CHAR(10)

The name of the 5250 device for which the translation is being done. The 5250 data stream that is generated depends on the capabilities of the display device. You can specify the following values:

Name The name of a display device that is known to the system.

Note: An error will occur if the job you are using for data stream translation is not authorized to the device you specify.
*REQUESTER The display device that is associated with this job is to be used.

Note: An error will occur if there is no display device associated with this job. For example, the job is a batch job.
*BASIC The display device is assumed to have the lowest common characteristics. The following characteristics are assumed:
  • The display is monochrome.

  • The display has a screen size of 24x80. If a larger screen size is specified when *BASIC is specified for the display device name, an error occurs.

  • Input in row 1, column 1 is not supported.

  • The Home key does not work like the 3270 home key.

  • The maximum number of input fields is 126.

  • The language is defaulted to the Keyboard Type (QKBDTYPE) system value.

  • The display does not support extended attributes.

Note: The full capabilities of the device can be determined only if a 5250 query has been sent to the device. The 5250 query is sent the first time a user signs on after the device is varied on. The results remain in effect until the device is varied off. If no one has signed on since the device was varied on, some of the characteristics will default to those assumed for *BASIC display devices.

Default screen size
INPUT; CHAR(10)

The size of the screen for the selected display device. Either this value or the alternate screen size value is used depending on the command used in the 3270 data stream. The possible screen sizes are:

024X080 24 lines by 80 columns
027X132 27 lines by 132 columns
*DEVMAX The maximum screen size allowed by the device

Alternate screen size
INPUT; CHAR(10)

The alternate size of the screen for the selected display device. Either this value or the default screen size value is used depending on the command used in the 3270 data stream. The possible screen sizes are:

024X080 24 lines by 80 columns
027X132 27 lines by 132 columns
*DEVMAX The maximum screen size allowed by the device

Error code
I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error code parameter.


Error Messages

Message ID Error Message Text
CPF3C90 E Literal value cannot be changed.
CPF3CF1 E Error code parameter not valid.
CPF5D50 E Display device description &1 not found.
CPF5D51 E Device &1 is not a display device.
CPF5D52 E Not authorized to display device &1.
CPF5D5B E Value &1 for default screen size parameter not valid.
CPF5D61 E Value for display device parameter not valid.
CPF5D66 E Value for alternate screen size parameter not valid.
CPF5D67 E Severe error occurred while addressing parameter list.
CPF5D68 E Default screen size parameter is not valid.
CPF5D69 E Alternate screen size parameter is not valid.
CPF9872 E Program or service program &1 in library &2 ended. Reason code &3.

API introduced: V2R2

[ Back to top | Communications APIs | APIs by category ]