NAME
fputws — put a
wide-character string on a stream
SYNOPSIS
#include <stdio.h>
#include <wchar.h>
int fputws(const wchar_t *restrict ws, FILE *restrict stream);
DESCRIPTION
[CX] The functionality described on this reference page is aligned with the ISO C standard. Any conflict between the requirements described here and the ISO C standard is unintentional. This volume of POSIX.1-2017 defers to the ISO C standard.
The fputws () function shall write
a character string corresponding to the (null-terminated) wide-character
string pointed to by
ws to the stream
pointed to by
stream.
No character corresponding to the terminating null wide-character code shall
be written.
[CX] The last data modification and last file
status change timestamps of the file shall be marked for update between the
successful execution of fputws () and the next
successful completion of a call to fflush(3) or
fclose(3) on the same stream or a call to
exit(3) or abort(3).
RETURN VALUE
Upon successful completion, fputws ()
shall return a non-negative number. Otherwise, it shall return -1, set an
error indicator for the stream, [CX] and set
errno to
indicate the error.
ERRORS
Refer to fputwc(3).
EXAMPLES
None.
APPLICATION USAGE
The fputws () function does not append a
<newline>.
This volume of POSIX.1-2017 requires that successful completion simply return a non-negative integer. There are at least three known different implementation conventions for this requirement:
- Return a constant value.
- Return the last character written.
- Return the number of bytes written. Note that this implementation convention cannot be adhered to for strings longer than {INT_MAX} bytes as the value would not be representable in the return type of the function. For backwards-compatibility, implementations can return the number of bytes for strings of up to {INT_MAX} bytes, and return {INT_MAX} for all longer strings.
RATIONALE
None.
FUTURE DIRECTIONS
None.
SEE ALSO
CHANGE HISTORY
First released in Issue 4. Derived from the MSE working draft.
Issue 5
The Optional Header (OH) marking is removed from <stdio.h>.
Issue 6
Extensions beyond the ISO C standard are marked.
The fputws () prototype is updated for
alignment with the ISO/IEC 9899:1999
(“ISO C99”) standard.
Issue 7
Changes are made related to support for finegrained timestamps.
POSIX.1-2008, Technical Corrigendum 1, XSH/TC1-2008/0176 [412] and XSH/TC1-2008/0177 [14] are applied.