Open Stream (QzdmOpenStream) API

Required Parameter Group:

1	Receiver variable	Output	Char(*)
2	Length of receiver variable	Input	Binary(4)
3	Format name of receiver variable	Input	Char(8)
4	Error code	I/O	Char(*)

  Library Name / Service Program: QSOC/QZDMMDTA

  Default Public Authority: *EXCLUDE

  Threadsafe: No

The Open Stream (QzdmOpenStream) API is used to open an OptiConnect stream. The Open Stream (QzdmOpenStream) API returns a stream identifier, which is then required as input for subsequent OptiConnect APIs that require a stream identifier.

Restrictions

The following restrictions apply:

The OptiConnect QSOC subsystem must be started on the local system prior to calling this API.
A maximum of 256 stream identifiers may be opened for a single job.

Authorities and Locks

Service Program Authority: *EXECUTE

Required Parameter Group

Receiver variable: OUTPUT; CHAR(*)
The receiver variable that is to receive the output control information from the Open Stream (QzdmOpenStream) API.
Length of receiver variable: INPUT; BINARY(4)
The length of the receiver variable, in bytes. The length of the receiver variable must be at least equal to or greater than the length of the output format.
Format name of receiver variable: INPUT; CHAR(8)
The format of the information that is returned from the Open Stream (QzdmOpenStream) API. The OSTR0100 format is used by this API for the receiver variable. See OSTR0100 Format for more information on the OSTR0100 format.
Error code: I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.

OSTR0100 Format

The following table defines the information returned for Format OSTR0100.

Offset		Type	Field
Dec	Hex	Type	Field
0	0	CHAR(16)	Stream identifier

Field Descriptions

Stream identifier. The OptiConnect stream that is to be used for communications. This field is provided as output with the Open Stream (QzdmOpenStream) API. This field must then be provided as input on all subsequent OptiConnect API requests that require a stream identifier.

Error Messages

Message ID	Error Message Text
CPF24B4 E	Severe error while addressing parameter list.
CPF3C1D E	Length specified in parameter &1 not valid.
CPF3C21 E	Format name &1 is not valid.
CPF3C90 E	Literal value cannot be changed.
CPF3CF1 E	Error code parameter not valid.
CPF9872 E	Program or service program &1 in library &2 ended. Reason code &3.
CPFADF0 E	The OptiConnect QSOC subsystem must be active.
CPFADF1 E	OptiConnect communication error.
CPFADF5 E	OptiConnect API internal error, function code &1, return code &2.

API introduced: V3R7

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