Set Window Services Attributes (QsnSetWinAtr) API

Required Parameter Group:

1	Window services attributes description	Input	Char(*)
2	Length of window service attributes description	Input	Binary(4)

Omissible Parameter:

Error code

I/O

Char(*)

Returned Value:

Return code

Output

Binary(4)

  Default Public Authority: *USE

  Service Program: QSNAPI

  Threadsafe: No

The Set Window Services Attributes (QsnSetWinAtr) API sets the default attributes for the window services.

Authorities and Locks

None

Required Parameter Group

Window services attributes: INPUT; CHAR(*)
Defines the attributes for the window services APIs. The format of the window services attributes description is shown in Format of the Window Services Attribute Description.
Length of window services attributes: INPUT; BINARY(4)
The length of the window services attributes parameter.

Omissible Parameter

Error code: I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter. If this parameter is omitted, diagnostic and escape messages are issued to the application.

Returned Value

Return code: OUTPUT; BINARY(4)
A return code indicating the result of the operation. The value returned will be 0 if the operation was successful, or -1 otherwise.

Format of the Window Services Attribute Description

Offset		Type	Field
Dec	Hex	Type	Field
0	0	CHAR(3)	Monochrome window display attributes
3	3	CHAR(3)	Color window display attributes

Field Descriptions

Color window display attributes. The window display attributes for a color display. The first character is the attribute for the window border when the window is not current, the second for when the window is current, and the third for the leading window attribute. The first attribute is ignored for GUI windows, which only use the second attribute. All bytes can contain the same value. The special value X'00' indicates that no screen attribute is to be used for the given character. Both the current and noncurrent border attributes must be either X'00' or a valid attribute. For example, it is incorrect to specify the current attribute field X'00' and the noncurrent attribute field with a valid attribute.

The default values for these fields are X'20' for green, X'3A' for blue, and X'20' for green.

Monochrome window display attributes. The window display attributes for a monochrome display. The first character is the attribute for the window border when the window is not current, the second for when the window is current, and the third for the leading window attribute. The first attribute is ignored for GUI windows, which only use the second attribute. All bytes may contain the same value. The special value X'00' indicates that no screen attribute is to be used for the given character. Both the current and noncurrent border attributes must be either X'00' or a valid attribute. For example, it is incorrect to specify the current attribute field X'00' and the noncurrent attribute field with a valid attribute.

The default values for these fields are X'20' for normal attribute, X'22' for high intensity, and X'20' for normal attribute, respectively.

Error Messages

Message ID	Error Message Text
CPF24B4 E	Severe error while addressing parameter list.
CPF3C1D E	Length specified in parameter &1 not valid.
CPF3CF1 E	Error code parameter not valid.
CPF3CF2 E	Error(s) occurred during running of &1 API.
CPFA31E E	Required parameter &1 omitted.
CPFA343 E	Output operation not done.
CPFA344 E	The file &2 in library &3 is not valid.
CPFA345 E	The invite active flag is not valid.
CPFA3AC E	Window services attributes description value is incorrect.

API introduced: V2R3

[ Back to top | Dynamic Screen Manager APIs | APIs by category ]