The data structure kc_message_module_str is defined for the object type KC_MESSAGE_MODULE. In the case of KC_GET_OBJECT, UTM returns the properties of the user-defined UTM message module of the application in kc_message_module_str.
In UTM applications on BS2000 systems, you can create several user-defined message modules that contain the UTM messages in various languages for the purpose of internationalization of the application. A language code and a territory code are assigned to each UTM message module to precisely define the language. The combination of the language code and the territory code must be assigned to exactly one UTM message module of the application. Through the "language and territory code" the user-defined UTM message modules are assigned to the users and LTERM partners whose locale contains the same language and territory code.
In UTM applications running on Unix, Linux or Windows systems, you can create userdefined message modules. UTM only returns the name of the message module. The other fields of the data structure are of no relevance.
User-defined UTM message modules are defined in the KDCDEF generation with a MESSAGE statement.
How a user-defined UTM message module is created is described in the openUTM manual ”Messages, Debugging and Diagnostics”.
Data structure kc_message_module_str |
|
|
|
|
|
The fields in the data structure have the following meanings:
mm_name
Contains the name of the UTM message module whose properties are returned by UTM.
lib (only on BS2000 systems)
Contains the name of the library that contains the UTM message module.
locale_lang_id, locale_terr_id (only on BS2000 systems)
Specifies the language environment for which the UTM message module will be used.
locale_lang_id
Contains the up to two characters long language code.
locale_terr_id
Contains an up to two characters long territory code.
The UTM messages of user-defined UTM message modules are used for the STATION, SYSLINE and PARTNER message lines. The UTM message module used corresponds to the locale_lang_id and locale_terr_id that is identical to the language and territory code of the locale of the respective user or LTERM partner.
standard_module (only on BS2000 systems)
Specifies if the message module is the user-defined standard message module of the application.
The standard message module is the user-defined message module that is assigned to the language and territory code of the standard language environment. The standard language environment is specified in the KDCDEF generation in MAX LOCALE.
The standard message module is always used by UTM for messages in the SYSLST, SYSOUT and CONSOLE message lines
'Y' | The message module is the standard message module. |
'N' | The message module is not the standard message module. |