Writing text data to a sequential file, socket or pipe adding newline

fputs

Write a newline terminated string to a sequential file, socket or pipe


SYNTAX

fputs file_handle expression [err = label] [to = timeout[:label]] [traps = label]

Writes data in ASCII text format to the sequential file, socket or pipe which is open on the specified file_handle and adds a newline.

file_handle

It can be the handle returned by the fopen command (it returns a negative number to differentitate the #channel case) or an integer in the range 1-64 specifying the number of the channel on which the sequential file, socket or pipe (opened by the open # command) is open. It may be a constant, field name or expression.

See Sequential files for more information.

expression

It can be a Sculptor keyed file field, !record field or a temporary field declared in the program. The field may be of any type.

Or just an expression (funcion calls, operations, constants…)

The data is written as text data directly from the supplied expression using the standard Sculptor conversion rules.

[err = label]

Errors return the trappable condition err, which may be trapped by the err = clause or by the general traps = clause. The error number is stored in the system variable sys.Error , and control passes to the line indicated by label. The error numbers are defined by manifest constants in the file errors.h, which is located in the Sculptor include directory. This file may be included in a program by means of an !include declaration. The possible errors are:

No

Manifest constant

Meaning

1

BAD_CHANNEL

file_handle is wrong

10

FPUTERR

file not open for writing or disk full

12

TIMEOUT_EXCEEDED

timeout exceeded

If an error occurs and is not trapped, an error message is displayed and control passes to the active menu, if any. If no menu is active the program exits.

[to = timeout[:label]]

Defines the timeout value and if the label is defined then control passes to the line indicated by label, in case the timeout is reached.

If this condition is not trapped, the error timeout exceeded is displayed and control passes to the active menu, if any. If no menu is active the program exits.

[traps = label]

General purpose trap clause that traps any condition not explicitly trapped, passing control to the line indicated by label. It has the lowest priority, and is only invoked if a trappable condition has not been more explicitly trapped. Although the err = clause is non-specific, it still takes priority over traps.


NOTES

  • If an alphanumeric field has the r or v flags, and the length of the data is less than the field length, the field is written as stored, preserving the field length, rather than padding with spaces.


EXAMPLE

Write a line to a file:

!temp fHandle,,i2
!temp lineTxt,,a128,,v = "This line is going to be written with a newline at the end"


fopen fHandle "seqfile" "w"
fputs fHandle lineTxt

RELATED TOPICS

fprintf

fgets

fread

fwrite

fopen

fclose

check #

get[field] #

put[field] #

Sequential files

Fcmds

Traps