CRE Programmer's Guide

CRE Service Functions
Common Run-Time Environment (CRE) Programmer’s Guide—528146-004
6-10
CRE_File_Message_
indent_bytes
if present, specifies whether or not CRE_File_Message_ should write your
message on multiple lines, if necessary and, if so, the indentation to use for all
lines after the first.
CRE_File_Message_ alters the contents of
buffer as follows, if your message
requires more than one line:
•
If indent_bytes > 0, each message line after the first line is indented by
indent_bytes characters.
•
If indent_bytes = 0, message lines after the first line are not indented.
•
If indent_bytes = -1, the message is written in its entirety on one line.
CRE_File_Message_ returns an error if the length of the message exceeds the
number of bytes that can be written to the output device.
•
If indent_bytes < -1, each message line after the first line uses the first
absolute_value(
indent_bytes) characters of the first line of the message as
a prefix.
read_count
if present, is the maximum number of bytes CRE_File_Message_ reads in
response to the message it writes. CRE_File_Message_ returns a response only if
read_count is greater than or equal to zero and the device type associated with
file_ordinal is a terminal or a process (other than a spooler collector). The
response is stored in
buffer. If you do not specify read_count,
CRE_File_Message_ does not return a response.
count_read
if present, is the actual number of bytes in the response. CRE_File_Message_ sets
count_read to -1 if it does not attempt to read a response or if its attempt to read
a response is not successful.
Return Value
CRE_File_Message_ returns one of the following:
•
0 if the message operation is successful
•
A positive number, which is a file system error number
•
A negative number, which is the negation of a CRE error number from the following
table:
Error Code Cause
55 Missing or invalid parameter
56 Invalid parameter value