__le_msg_add_insert() — Add insert to a Language Environment® message

Standards

Format

#include <__le_api.h>

void  *__le_msg_add_insert(_FEEDBACK * cond_token,
                           _INT4 * insert_seq_num,
                           _VSTRING * insert_data,
                           _FEEDBACK * fc);

General description

Copies message insert data and loads the address of that data into the Instance Specific Information (ISI) associated with the condition being processed. The number of ISIs per thread is limited to 15.

Parameter

Description

cond_token

A 16–byte condition token that defines the condition for which the q_data_token is retrieved.

insert_seq_num

A 4–byte integer that contains the insert sequence number (such as insert 1 insert 2). It corresponds to an insert number specified with an :ins. tag in the message source file created by the CEEBLDTX utility. For more information about the CEEBLDTX utility see z/OS Language Environment Programming Guide.

insert_data

A halfword-prefixed length string, used without truncation, that represents the insert data. DBCS strings must be enclosed within shift-out (0x0E) and shift-in (0x0F) characters.

Note: The maximum size for an individual insert item is 254 bytes.

fc

A 16–byte Feedback Code indicating the results of this function.

Table 1. Feedback Codes for __le_msg_add_insert()

Code	Severity	Message Number	Message Text
CEE000	0	- -	The function completed successfully.
CEE0EB	3	459	Not enough storage was available to create a new Instance Specific Information block.
CEE0EC	1	460	Multiple instances of the condition token with message number message-number and facility ID facility-id were detected.
CEE0ED	3	461	The maximum number of unique message insert blocks was reached. This condition token had it's I_S_info field set to 1.
CEE0EE	3	462	Instance Specific Information for the condition token with message number message-number and facility ID facility-id could not be found.
CEE0EF	3	463	The maximum size for an insert data item was exceeded be located.
CEE0H9	3	553	An internal error was detected in creating the inserts for a condition.

Usage notes

1. z/OS® UNIX System Services consideration – In multithreaded applications, __le_msg_add_insert() applies to message insert data for only the invoking thread.

Related information

• __le_api.h
• __le_msg_get() — Get a Language Environment message
• __le_msg_get_and_write() — Get and output a Language Environment message
• __le_msg_write() — Output a Language Environment message to stderr