kc_edit_str - EDIT profile options (BS2000 systems)

The data structure kc_edit_str is defined for the object type KC_EDIT. With KC_GET_OBJECT, UTM returns information on EDIT profiles in kc_edit_str.

EDIT profiles are generated with the KDCDEF control statement EDIT. Screen functions and properties of the screen output in line mode are summarized in EDIT profiles. Each EDIT profile is assigned a name in the KDCDEF generation via which the corresponding set of edit options can be accessed from a program unit run.

A complete description of the edit options discussed in the following can be found in the TRANSDATA TIAM User Guide. You will find more detailed information on working with EDIT profiles in the openUTM manual „Programming Applications with KDCS”.

Data structure kc_edit_str         

char ed_name[8];

char edit_mode;

char edit_bell;

char hcopy;

char hom;

char ihdr;

char locin;

char low;

char nolog;

char ohdr;

char saml;

char specin;

char ccsname[8];

The fields in the data structure have the following meanings:

ed_name
	Contains the name of the EDIT profile whose edit options UTM will return. It is an alphanumeric name up to seven characters long.
edit_mode
	Specifies the mode in which the messages will be output:
	'E'									(extended line mode) The messages are output in "extended line mode".
	'I'									(info) The message can be indicated in a special information line (system line) without important data being overwritten at the terminal.
	'L'									(line mode) The message is output in line mode. It can be structured using logical control characters. The message is prepared by the system.
	'P'									(physical mode) The message is physically input or output, i.e. without being prepared by the system.
	'T'									(transparent mode) The output message is transmitted transparently.
edit_bell
	Specifies if an acoustic alarm is to be triggered when the message is output on the terminal. The contents of the field mean:
	'Y'									An acoustic alarm will be triggered.
	'N'									An acoustic alarm will not be triggered.
hcopy	(hard copy) Specifies if an output message is also to be logged by a hardcopy printer connected to the terminal in addition to the output on the terminal.
	'Y'									Logging of output messages on a hard-copy printer
	'N'									No logging
hom	(homogeneous) Specifies if the output message is output without structure, i.e. homogeneously output.
	'Y'									The message will be without structure
	'N'									The message will be structured. In this case, a logical line is considered to be the unit of output.
ihdr	(input header) Specifies if the message header of the input message is to be passed to the program unit.
	'Y'									The message header of the input message will be passed.
	'N'									The message header will not be passed.
locin	(local input parameter) Specifies if local attributes in the input message are passed to the user as logical control characters.
	'Y'									Local attributes in the input message are passed as logical control characters.
	'N'									Local attributes are removed and not passed.
low	(lower case) Specifies if the input message passed to the program unit may also contain lowercase letters.
	'Y'									Lowercase letters in the input message are passed to the program unit.
	'N'									Lowercase letters are converted to uppercase before being passed to the program unit.
nolog	(no logical characters) Specifies how non-printable characters will be handled by the system.
	'Y'									The logical control characters will not be evaluated. All characters that are smaller than X'40' in the EBCDIC code will be replaced by substitute characters (SUB). Only printable characters will be allowed through.
	'N'									All logical control characters are evaluated. Special physical control characters will be allowed through. Other characters smaller than X'40' will be replaced by substitute characters (SUB). Printable characters will be allowed through.
ohdr	(output header) Specifies if the output message contains a message header. The length of the message header +1 will be entered in binary in the first byte of the message.
	'Y'									The output message contains a message header.
	'N'									The output message does not contain a message header.
saml	(same line) Specifies if a line feed at the beginning of the message is to be suppressed. The contents of saml is only significant for printers. The contents of the saml field have the following meaning:
	'Y'									No line feed is executed at the beginning of the message.
	'N'									The message starts at the beginning of the next line.
specin (special input)
	Specifies which special options the edit profile contains for the input.
	'C'									(confidential) The input data is darkened when displayed on the terminal.
	'I'									(ID card) The next entry will be input via the ID reader.
	'N'									(normal) Normal input from the terminal.
ccsname (coded character set name)
	Contains the name of the character set (CCS name) used to prepare a message (see also the XHCS User Guide).