ASSIGN-STREAM

Assign S variable stream

Component:	SDF-P-BASYS
Functional area:	Procedures
Domain:	PROCEDURE
Privileges:	STD-PROCESSING OPERATING HARDWARE-MAINTENANCE SAT-FILE-EVALUATION SAT-FILE-MANAGEMENT SECURITY-ADMINISTRATION

Function

The ASSIGN-STREAM command assigns an S variable stream to a variable or a server (e.g. FHS). See also “S variable streams” in the “SDF-P” manual [34].

Restrictions

Assignment of an S variable stream to a variable using TO=*VARIABLE(...) is not possible unless the chargeable SDF-P subsystem is loaded. 

Format

ASSIGN-STREAM

STREAM-NAME = SYSVAR / SYSMSG / SYSINF / <structured-name 1..20>
,TO = *STD / <structured-name 1..20> / *DUMMY / *SAME-AS-CALLING-PROC / *VARIABLE(...) /
			*SERVER(...)
	*VARIABLE(...)
		|		VARIABLE-NAME = *NONE / <composed-name 1..255>(...)
		|			<composed-name>(...)
		|				|	WRITE-MODE = *EXTEND / *PREFIX
		|		,RETURN-VARIABLE-NAME = *NONE / <composed-name 1..255>(...)
		|			<composed-name 1..255>(...)
		|				|	WRITE-MODE = *EXTEND / *PREFIX
		|		,CONTROL-VAR-NAME = *NONE / <composed-name 1..255>(...)
		|			<composed-name 1..255>(...)
		|				|	WRITE-MODE = *EXTEND / *PREFIX
		|		,RET-CONTROL-VAR-NAME = *NONE / <composed-name 1..255>(...)
		|			<composed-name 1..255>(...)
		|				|	WRITE-MODE = *EXTEND / *PREFIX
	*SERVER(...)
		|		SERVER-NAME = <structured-name 1..30>
		|		,SERVER-INFORMATION = *NONE / <c-string 1..1800>

Operands

STREAM-NAME = <structured-name 1..20> / SYSVAR / SYSMSG / SYSINF
Assigns an S variable stream. The operand values SYSINF, SYSMSG, and SYSVAR are reserved words. They must not be abbreviated.

• SYSINF: contains structured outputs from commands and programs
• SYSMSG: contains structured guaranteed messages
• SYSVAR: contains information from SYSINF and SYSVAR; however, it is still possible to process the different data items separately.

TO =
Specifies the server which is assigned to the current S variable stream.

TO = *STD
Default assignment. The following table indicates the default values used internally by TO for the various combinations featuring the STREAM-NAME operand. 

STREAM-NAME=	TO=*STD	Information contained
SYSINF	SYSVAR	structured outputs from commands and programs
SYSMSG	SYSVAR	Structured guaranteed messages
SYSVAR	*DUMMY	structured outputs from commands and programs and structured guaranteed messages
<structured-name 1..20>	*DUMMY	User variable stream

TO = <structured-name 1..20>
Name of the user server.
Any loops in chains of S variable stream assignments will be rejected; e.g.

ASSIGN-STREAM S3,*DUMMY
ASSIGN-STREAM S2,S3
ASSIGN-STREAM S3,S2          -----> SDP0511

TO = *DUMMY
No assignment. Transmitted variables are lost. The client is informed of this by a warning.

TO = *SAME-AS-CALLING-PROC
Assigns the calling procedure's server. If there is no assignment in the calling procedure, the assignment is rejected and the S variable stream remains unaltered.

TO = *VARIABLE(...)
The server is SDF-P. The transmitted variables are written to the specified S variables, or read from it.
Specification is only possible if the chargeable SDF-P subsystem is loaded. The operands of the *VARIABLE(...) structure are completely described in the “SDF-P” manual [34].

TO = *SERVER(...)
Links the S variable stream with the specified server.

SERVER-NAME = <structured-name 1..30>
Name of the server.

SERVER-INFORMATION =
Information which must be sent to the server, e.g. the name of the format library for FHS.

SERVER-INFORMATION = *NONE
No information must be sent to the server.

SERVER-INFORMATION = <c-string 1..1800>
Text of the message, in the form of a string. 

Return codes

(SC2)	SC1	Maincode	Meaning
	0	CMD0001	No errors
2	0	SDP0531	Warning by the server; process being continued
	1	CMD0202	Syntax error
	3	CMD2203	Incorrect syntax file
	32	CMD0221	System error (internal error)
	64	CMD0216	User does not have the required privilege
	64	SDP0091	Semantic error
	64	SDP0532	Server error; command rejected
	64	SDP0534	Internal server error; command terminated. Server link terminated following unexpected event or due to shortage or absence of system resources
	130	SDP0099	No further address space available

Example

See the SHOW-STREAM-ASSIGNMENT and TRANSMIT-BY-STREAM commands in the “SDF-P” manual [34].