Home / Autodocs / dos.library
NAME
- VFWritef
-
write a BCPL formatted string to a file (buffered) (V36)
SYNOPSIS
count = VFWritef(fh, fmt, argv)
D0 D1 D2 D3
LONG VFWritef(BPTR, STRPTR, LONG *)
count = FWritef(fh, fmt, ...)
LONG FWritef(BPTR, STRPTR, ...)
D0 D1 D2 D3
LONG VFWritef(BPTR, STRPTR, LONG *)
count = FWritef(fh, fmt, ...)
LONG FWritef(BPTR, STRPTR, ...)
FUNCTION
Writes the formatted string and values to the specified file. This function is assumed to handle all internal buffering so that the formatting string and resultant formatted values can be arbitrarily long. The formats are in BCPL form. This operation is buffered.
Supported formats are: (Note that x is in base 36, i.e. hexadecimal!)
Supported formats are: (Note that x is in base 36, i.e. hexadecimal!)
- "%S"
-
string (CSTR)
- "%Tx"
-
writes a left-justified string in a field at least x bytes long.
- "%C"
-
writes a single character
- "%Ox"
-
writes a number in octal, maximum x characters wide
- "%Xx"
-
writes a number in hex, maximum x characters wide
- "%Ix"
-
writes a number in decimal, maximum x characters wide
- "%N"
-
writes a number in decimal, any length
- "%Ux"
-
writes an unsigned number, maximum x characters wide
- "%$"
-
ignore parameter
- Note:
-
'x' above is actually the character value - '0'.
INPUTS
- fh
-
FileHandle to write to
- fmt
-
BCPL style formatting string
- argv
-
Pointer to array of formatting values
NOTES
The FWritef() function is not intended to be used as a replacement for FPrintf() or the 'C' compiler library function fprintf(). It is useful only within the narrow context of providing for backwards compatibility with software written for legacy shell commands and tools of the Kickstart 1.x era 1985-1989 (V32-V34).
RESULT
- count
-
Number of bytes written or -1 for error; call IoErr() to find out why FWritef() has failed.
BUGS
As of V37, VFWritef() does NOT return a valid return value. In order to reduce possible errors, the prototypes supplied for the system as of V37 have it typed as VOID.