kc_sfunc_str - Function keys

The data structure r kc_sfunc_str is defined for object type KC_SFUNC. In kc_sfunc_str, In the case of KC_GET_OBJECT, UTM returns the short description of a function key generated in the application and specifies which function is allocated to this function key.

A transaction code, a command, a KDCS return code can be assigned to a function key or it can be used for the stacking of services.

For UPIC clients, only the parameter ret is evaluated.

Data structure kc_sfunc_str

char sf_name[4];

char tac[8];

char stack[8];

char ret[3];

char cmd[8];

The fields in the data structure have the following meanings:

sf_name
	Contains the short description of the function key. Possible values are: BS2000 systems: K1 to K14 and F1 to F24 Short messages containing only the value of the key are issued with the K keys. K14 is used for ID card readers (see openUTM manual „Programming Applications with KDCS”, ID card readers). Unix, Linux and Windows systems: F1 to F20 You can transfer the value of the F key and an input message with the F keys.
tac	Contains the name of the transaction code (service TAC) allocated to this function key. If the function key is pressed when the service is not activated, the service belonging to the transaction code is started. If the function key is pressed while a service is running, then the function assigned to the function key with ret or stack takes effect. If these two fields do not contain any values, the first MGET call returns the code 19Z in the next program unit of the service.
stack	This is used to stack services. stack contains the name of the dialog transaction code assigned to this function key. If the function key is pressed while a service is active, the current service is stacked and the service with the transaction code in stack is started. If the function key is pressed when no service is active the transaction code contained in the tac field is started. If the field tac contains no value, pressing the function key causes the service to be started that has the transaction code contained in stack.
ret	Contains a KDCS return code. If this function key is pressed while a service is running, then the field KCRCCC in the communication area will contain the return code after the MGET call. If this key is pressed when a service is started and if tac does not contain a value, UTM issues message K009 or starts the BADTACS program unit. This program unit contains the return code assigned to the function key in the first MGET call in the field KCRCCC. Possible values: 20Z <= ret <= 39Z. If a UPIC client transmits the function key, on the field ret is evaluated.
cmd	Name of a KDC command (e.g. KDCOFF or an administration command such as KDCINF) which is activated when the function key is pressed. If cmd contains a value, the fields tac, ret and stack contain blanks.