__le_condition_token_build() — Build a Language Environment condition token
Standards
Standards / Extensions | C or C++ | Dependencies |
---|---|---|
Language Environment |
both | AMODE 64 |
Format
#include <__le_api.h>
void *__le_condition_token_build(_INT2 * c_1, _INT2 * c_2,
_INT2 * format, _INT2 * severity,
_INT2 * control, _CHAR3 facility_ID,
_INT4 * i_s_info,
_FEEDBACK * cond_token,
_FEEDBACK * fc);
General description
Dynamically constructs a 16–byte Language Environment® condition token. The condition token is only to be used to retrieve messages from a Language Environment message file.
- Parameter
- Description
- c_1
- c_1 is a 2–byte binary integer representing the value of the first 2 bytes of the 4–byte condition_ID. c_1 and c_2 make up the condition_ID portion of the condition token.
- c_2
- c_2 is a 2–byte binary integer
representing the value of the second 2 bytes of the 4–byte condition_ID.
For format 1, this is the Msg_No; for format 2, the cause_code.
- format
- A 2–byte binary integer defining the format of the condition_ID portion of the token.
- severity
- A 2–byte binary integer indicating the condition's severity.
In both format 1 and 2 conditions, this field is used to test the
condition's severity. For format 1 conditions, the value of this field
is the same as the severity value specified in the condition_ID.
- Possible severity Values:
-
0 = Information only, if entire token is 0 there is no
information.
1 = Warning
2 = Error
3 = Severe Error
4 = Critical Error
- control
- A 2–byte binary integer containing flags describing or controlling various aspects of condition handling. Valid values for the control field are 1 and 0. 1 indicates the facility_ID assigned by IBM®, 0 indicates the facility_ID assigned by the user.
- facility_ID
- A 3 character field containing three alphanumeric characters (A-Z,
a-z, and 0-9) identifying the product or component of a product generating
this condition or feedback information, for example, CEE.
The facility_ID is associated with the repository of the runtime messages. If a unique ID is required (for IBM and non-IBM products), an ID can be obtained by contacting an IBM project office.
If you creat a new facility_ID to use with a message table, created using the CEEBLDTX utility, be aware that the facility_ID must be part of the Language Environment message table name. For more information about the CEEBLDTX utility, see z/OS Language Environment Programming Guide. It is important to follow the naming guidelines below in order to have a module name that does not cause your application to abend.
First, begin a non-IBM assigned product facility_ID with letters J through Z. (See the control parameter above to indicate whether the facility_ID has been assigned by IBM.) Secondly, special characters, including blank spaces, cannot be used in a facility_ID. Lastly, there are no other constraints (besides the alphanumeric requirement) on a non-IBM assigned facility_ID.
- i_s_info
- A fullword binary integer identifying the ISI, that contains insert data.
- cond_token
- A 16–byte representation of the constructed condition token.
- fc
- A 16–byte Feedback Code indicating the results of this function.
Table 1. Feedback Codes for __le_condition_token_build() Code Severity Message Number Message Text CEE000 0 - - The function completed successfully. CEE0CH 3 401 A non-valid case code case-code was passed to routine routine-name. CEE0CI 3 402 A non-valid control code control-code was passed to routine routine-name. CEE0CJ 3 403 A non-valid severity code severity-code was passed to routine routine-name. CEE0CK 3 404 Facility ID, facility-id, with non-alphanumeric characters was passed to routine routine-name. CEE0E4 1 452 An invalid facility ID facility-id was passed to routine routine-name.
Usage notes
- The structure of the condition token (type _FEEDBACK) is described in the "__le_api.h" header file shipped with Language Environment. You can assign values directly to the fields of the token in the header file without using the __le_condition_token_build() function.
- This condition token is only to be used to retrieve messages from a Language Environment message table.