CBL_NLS_READ_MSG
Reads a message from a National Language Support (NLS) message file.
Syntax:
call "CBL_NLS_READ_MSG" using msg-file-handle
full-msg-number
msg-ins-struct
msg-buffer
returning status-code
Parameters:
|
Using call prototype (see Library Routines - Key) |
Picture (32-bit systems) |
msg-file-handle |
cblt-x4-compx. |
pic x(4). |
full-msg-number |
Group predefined as cblt-nls-msg-number-pair containing: |
Group containing: |
|
cblte-nmnp-set-number |
|
cblt-x2-compx. |
|
pic x(2) comp-x. |
|
cblte-nmnp-number |
|
cblt-x2-compx. |
|
pic x(2) comp-x. |
msg-ins-struct |
Group predefined as cblt-nls-msg-ins-struct containing: |
Group containing: |
|
cblte-nmis-ins-count |
|
cblt-x2-compx. |
|
pic x(2) comp-x. |
|
cblte-nmis-ins-pointer |
|
cblt-pointer. Occurs depending on cblte-nmis-ins-count. |
|
usage pointer occurs n times. |
msg-buffer |
Group predefined as cblt-nls-msg-buffer containing: |
Group containing: |
|
cblte-nmb-buff-len |
|
cblt-x2-compx. |
|
pic x(2) comp-x. |
|
cblte-nmb-buff-text |
|
cblt-x2-compx. Occurs depending on cblte-nmb-buff-len |
|
pic x(n). |
status-code |
See Library Routines - Key. |
On Entry:
msg-file-handle |
The identifying handle of the message file to fetch the message from. |
cblte-nmnp-set-number |
The set in the message file to fetch the message from. |
cblte-nmnp-number |
The message number in the message set to fetch the message from. |
cblte-nmis-ins-count |
The number of portions of text to insert in the message. |
cblte-nmis-ins-pointer |
A pointer to a null-terminated portion of text to insert in the message. |
cblte-nmb-buff-len |
The length of msg-buff-text. |
On Exit:
cblte-nmb-buff-text |
The returned text (null-terminated). |
status-code |
Indicates whether the routine was successful:
0 |
Success |
40 |
NLS module not initialized |
401 |
Message set not found |
402 |
Message not found in set |
403 |
Message too long for message text buffer |
404 |
Invalid msg-file-handle |
If status-code contains a value other than these, it is the number of a
run-time error message. |
Comments:
In each message file, messages are divided into sets; this enables you to
define your own message set in the default message file if you want. This
routine also enables you to insert portions of text in a message fetched from
the message file in the order appropriate to the rules of the grammar for
the national language.
See Also: