CATREAD

Syntax

  I16                   I32V      I16V    I16V    U16A
  msglength := CATREAD (catindex, setnum, msgnum, catstatus,

    CA      I16V        CA     CA     CA     CA     CA     I16V
    buffer, buffersize, parm1, parm2, parm3, parm4, parm5, msgdest);

Functional Return

msglength

16-bit signed integer (assigned functional return)

Returns the length of the message (in bytes).

Parameters

catindex

32-bit signed integer by value (required)

Passes the index (returned by the CATOPEN intrinsic) that specifies the message catalog to be used. The message catalog must have been formatted with the GENCAT utility.

setnum

16-bit signed integer by value (required)

Passes the message set number within the catalog (1..255).

msgnum

16-bit signed integer by value (required)

Passes the message number within the message set (0..32,766).

catstatus

16-bit unsigned integer array (required)

Returns two elements; the first element is the error number, the second element is reserved and always returns 0. The possible values of the first element returned are:

Value

Meaning

0

Successful

1

Invalid catindex specified

2

Read failed on catalog file

3

Message set not found

4

Message number not found

6

User buffer overflow

7

Write to msgdest file failed

14

setnum <= 0 specified

15

setnum > 255 specified

16

msgnum < 0 specified

17

msgnum > 32,766 specified

18

buffersize <= 0 specified

19

msgdest <= -2 specified

100

Internal message facility error

buffer

character array (optional)

Returns the assembled message.

buffersize

16-bit signed integer by value (optional)

Passes the buffer length in bytes if you specify buffer. Passes the length (in bytes) of the message to be written to the destination file if buffer is not specified.

Default = 72 bytes.

parm1-parm5

character arrays (optional)

Passes parameters to be inserted into the message. The parameter must always point to a character string and the character string must be terminated by a binary zero.

msgdest

16-bit signed integer by value (optional)

Passes the file number of the message's destination file (0 or -1 = $STDLIST, >2 = file number of the destination file). If buffer or msgdest are not specified, the message goes to $STDLIST ($STDLIST = 0).

Operation Notes

Related Information

Intrinsics

CATCLOSE, CATOPEN

Commands

None

Manuals

Message Catalogs Programmer's Guide