2004-11-03 13:51:07 +00:00
|
|
|
.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
|
|
|
|
|
.\"
|
|
|
|
|
.\" This is free documentation; you can redistribute it and/or
|
|
|
|
|
.\" modify it under the terms of the GNU General Public License as
|
|
|
|
|
.\" published by the Free Software Foundation; either version 2 of
|
|
|
|
|
.\" the License, or (at your option) any later version.
|
|
|
|
|
.\"
|
|
|
|
|
.\" References consulted:
|
|
|
|
|
.\" GNU glibc-2 source code and manual
|
|
|
|
|
.\" Dinkumware C library reference http://www.dinkumware.com/
|
intro.1, time.1, accept.2, bind.2, connect.2, execve.2, flock.2, getdents.2, getpriority.2, getuid.2, intro.2, ioctl.2, mincore.2, mknod.2, personality.2, ptrace.2, read.2, recv.2, select_tut.2, send.2, sendfile.2, shmctl.2, sigaction.2, signal.2, stat.2, times.2, truncate.2, umask.2, wait.2, MB_CUR_MAX.3, MB_LEN_MAX.3, argz_add.3, btowc.3, clearenv.3, clock.3, cmsg.3, end.3, endian.3, errno.3, exit.3, fgetwc.3, fgetws.3, fopen.3, fputwc.3, fputws.3, fseek.3, fwide.3, getfsent.3, getgrnam.3, gethostid.3, getipnodebyname.3, getmntent.3, getpwnam.3, getwchar.3, grantpt.3, iconv.3, iconv_close.3, iconv_open.3, insque.3, intro.3, iswalnum.3, iswalpha.3, iswblank.3, iswcntrl.3, iswctype.3, iswdigit.3, iswgraph.3, iswlower.3, iswprint.3, iswpunct.3, iswspace.3, iswupper.3, iswxdigit.3, malloc.3, mblen.3, mbrlen.3, mbrtowc.3, mbsinit.3, mbsnrtowcs.3, mbsrtowcs.3, mbstowcs.3, mbtowc.3, mkstemp.3, mktemp.3, nl_langinfo.3, openpty.3, posix_openpt.3, printf.3, ptsname.3, putwchar.3, qecvt.3, rcmd.3, readdir.3, rexec.3, rpc.3, setnetgrent.3, shm_open.3, sigpause.3, stdin.3, stpcpy.3, strftime.3, strptime.3, syslog.3, towctrans.3, towlower.3, towupper.3, ttyslot.3, ungetwc.3, unlocked_stdio.3, wcpcpy.3, wcpncpy.3, wcrtomb.3, wcscasecmp.3, wcscat.3, wcschr.3, wcscmp.3, wcscpy.3, wcscspn.3, wcsdup.3, wcslen.3, wcsncasecmp.3, wcsncat.3, wcsncmp.3, wcsncpy.3, wcsnlen.3, wcsnrtombs.3, wcspbrk.3, wcsrchr.3, wcsrtombs.3, wcsspn.3, wcsstr.3, wcstok.3, wcstombs.3, wcswidth.3, wctob.3, wctomb.3, wctrans.3, wctype.3, wcwidth.3, wmemchr.3, wmemcmp.3, wmemcpy.3, wmemmove.3, wmemset.3, wprintf.3, console_ioctl.4, pts.4, elf.5, filesystems.5, hosts.5, proc.5, ttytype.5, boot.7, capabilities.7, credentials.7, epoll.7, glob.7, koi8-r.7, path_resolution.7, pty.7, signal.7, suffixes.7, time.7, unicode.7, unix.7, uri.7, utf-8.7: global fix: s/Unix/UNIX/
The man pages were rather inconsistent in the use of "Unix"
versus "UNIX". Let's go with the trademark usage.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-10-12 04:45:38 +00:00
|
|
|
.\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" ISO/IEC 9899:1999
|
|
|
|
|
.\"
|
_exit.2, brk.2, capget.2, chdir.2, chmod.2, chown.2, chroot.2, getdtablesize.2, gethostname.2, getpagesize.2, getsid.2, killpg.2, mknod.2, mknodat.2, poll.2, posix_fadvise.2, pread.2, readlink.2, setpgid.2, setreuid.2, sigaltstack.2, stat.2, symlink.2, sync.2, truncate.2, vfork.2, wait.2, wait4.2, a64l.3, abs.3, acos.3, acosh.3, asin.3, asinh.3, atan.3, atan2.3, atoi.3, cbrt.3, ceil.3, copysign.3, cosh.3, dirfd.3, div.3, ecvt.3, erf.3, erfc.3, exp.3, exp2.3, fabs.3, fdim.3, ffs.3, floor.3, fma.3, fmax.3, fmin.3, fmod.3, fpclassify.3, frexp.3, ftw.3, fwide.3, gcvt.3, getcwd.3, getdate.3, getgrent.3, gethostid.3, getpass.3, getpwent.3, getsubopt.3, getw.3, hypot.3, ilogb.3, index.3, isalpha.3, isgreater.3, iswblank.3, j0.3, ldexp.3, lockf.3, log.3, log10.3, log1p.3, logb.3, lrint.3, lround.3, mkstemp.3, mktemp.3, modf.3, mq_receive.3, mq_send.3, nan.3, nextafter.3, posix_fallocate.3, posix_memalign.3, printf.3, qecvt.3, random.3, realpath.3, remainder.3, remquo.3, rint.3, round.3, scalb.3, scalbln.3, scanf.3, siginterrupt.3, signbit.3, sigset.3, sinh.3, sqrt.3, strcasecmp.3, strcat.3, strchr.3, strcmp.3, strcoll.3, strcpy.3, strfry.3, strpbrk.3, strsep.3, strspn.3, strstr.3, strtod.3, strtok.3, strtol.3, strtoul.3, strxfrm.3, tanh.3, tgamma.3, trunc.3, ttyslot.3, ualarm.3, usleep.3, wprintf.3, armscii-8.7, cp1251.7, iso_8859-10.7, iso_8859-11.7, iso_8859-13.7, iso_8859-14.7, iso_8859-3.7, iso_8859-5.7, iso_8859-6.7, iso_8859-8.7, koi8-u.7: tstamp
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-09-19 17:19:13 +00:00
|
|
|
.TH FWIDE 3 2010-09-20 "GNU" "Linux Programmer's Manual"
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH NAME
|
|
|
|
|
fwide \- set and determine the orientation of a FILE stream
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.nf
|
|
|
|
|
.B #include <wchar.h>
|
|
|
|
|
.sp
|
|
|
|
|
.BI "int fwide(FILE *" stream ", int " mode );
|
|
|
|
|
.fi
|
2007-07-08 12:11:40 +00:00
|
|
|
.sp
|
|
|
|
|
.in -4n
|
|
|
|
|
Feature Test Macro Requirements for glibc (see
|
|
|
|
|
.BR feature_test_macros (7)):
|
|
|
|
|
.in
|
2010-09-18 18:59:11 +00:00
|
|
|
.ad l
|
2007-07-08 12:11:40 +00:00
|
|
|
.sp
|
|
|
|
|
.BR fwide ():
|
2010-09-18 18:59:11 +00:00
|
|
|
.RS 4
|
2010-09-18 19:03:24 +00:00
|
|
|
_XOPEN_SOURCE\ >=\ 500 || _ISOC99_SOURCE ||
|
|
|
|
|
_POSIX_C_SOURCE\ >=\ 200112L;
|
2010-09-18 18:59:11 +00:00
|
|
|
.br
|
|
|
|
|
or
|
2007-07-08 12:11:40 +00:00
|
|
|
.I cc\ -std=c99
|
2010-09-18 19:03:24 +00:00
|
|
|
.RE
|
2010-09-18 18:59:11 +00:00
|
|
|
.ad
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH DESCRIPTION
|
2007-05-12 09:06:04 +00:00
|
|
|
When \fImode\fP is zero, the
|
|
|
|
|
.BR fwide ()
|
|
|
|
|
function determines the current
|
2007-04-12 22:42:49 +00:00
|
|
|
orientation of \fIstream\fP.
|
2008-07-09 15:22:08 +00:00
|
|
|
It returns a positive value if \fIstream\fP is
|
2007-06-08 11:56:22 +00:00
|
|
|
wide-character oriented, that is, if wide-character I/O is permitted but char
|
2007-04-12 22:42:49 +00:00
|
|
|
I/O is disallowed.
|
2008-07-09 15:22:08 +00:00
|
|
|
It returns a negative value if \fIstream\fP is byte oriented,
|
2008-09-10 03:41:35 +00:00
|
|
|
i.e., if char I/O is permitted but wide-character I/O is disallowed.
|
2007-04-12 22:42:49 +00:00
|
|
|
It
|
2004-11-03 13:51:07 +00:00
|
|
|
returns zero if \fIstream\fP has no orientation yet; in this case the next
|
|
|
|
|
I/O operation might change the orientation (to byte oriented if it is a char
|
2007-04-24 19:40:35 +00:00
|
|
|
I/O operation, or to wide-character oriented if it is a wide-character I/O
|
2004-11-03 13:51:07 +00:00
|
|
|
operation).
|
|
|
|
|
.PP
|
|
|
|
|
Once a stream has an orientation, it cannot be changed and persists until
|
|
|
|
|
the stream is closed.
|
|
|
|
|
.PP
|
intro.1, time.1, adjtimex.2, capget.2, eventfd.2, fcntl.2, getrlimit.2, getsockopt.2, gettimeofday.2, intro.2, ioctl_list.2, ioperm.2, mlock.2, pivot_root.2, poll.2, prctl.2, ptrace.2, sched_setscheduler.2, select_tut.2, semget.2, sigaltstack.2, signalfd.2, sysctl.2, timer_settime.2, timerfd_create.2, wait.2, CPU_SET.3, argz_add.3, assert_perror.3, atexit.3, backtrace.3, bcmp.3, clearenv.3, ctime.3, dl_iterate_phdr.3, dlopen.3, ecvt.3, errno.3, error.3, ether_aton.3, exit.3, fenv.3, ferror.3, finite.3, flockfile.3, fnmatch.3, fpathconf.3, fpclassify.3, ftime.3, ftok.3, ftw.3, fwide.3, getaddrinfo.3, gethostbyname.3, getlogin.3, getnameinfo.3, getnetent.3, getopt.3, getprotoent.3, getrpcent.3, getservent.3, glob.3, hsearch.3, inet.3, isalpha.3, iswalnum.3, iswalpha.3, iswblank.3, iswcntrl.3, iswctype.3, iswdigit.3, iswgraph.3, iswlower.3, iswprint.3, iswpunct.3, iswspace.3, iswupper.3, iswxdigit.3, longjmp.3, lsearch.3, malloc.3, matherr.3, mblen.3, mbsinit.3, mbtowc.3, on_exit.3, printf.3, pthread_attr_init.3, pthread_attr_setaffinity_np.3, pthread_attr_setdetachstate.3, pthread_attr_setguardsize.3, pthread_attr_setinheritsched.3, pthread_attr_setschedparam.3, pthread_attr_setschedpolicy.3, pthread_attr_setscope.3, pthread_attr_setstack.3, pthread_attr_setstackaddr.3, pthread_attr_setstacksize.3, pthread_cancel.3, pthread_cleanup_push.3, pthread_equal.3, pthread_getattr_np.3, pthread_getcpuclockid.3, pthread_setaffinity_np.3, pthread_setcancelstate.3, pthread_setconcurrency.3, pthread_setschedparam.3, pthread_setschedprio.3, ptsname.3, putenv.3, putgrent.3, raise.3, rcmd.3, regex.3, rexec.3, rpc.3, rpmatch.3, rtnetlink.3, scandir.3, sem_init.3, setaliasent.3, setbuf.3, setenv.3, setjmp.3, signbit.3, stdio_ext.3, strtod.3, strtol.3, strtoul.3, system.3, termios.3, timeradd.3, tzset.3, ualarm.3, wctomb.3, xdr.3, st.4, tty_ioctl.4, core.5, elf.5, proc.5, bootparam.7, capabilities.7, icmp.7, ip.7, ipv6.7, math_error.7, mdoc.samples.7, mq_overview.7, pthreads.7, raw.7, regex.7, socket.7, tcp.7, tzselect.8: Global fix: s/non-zero/nonzero/
The tendency in English, as prescribed in style guides like
Chicago MoS, is towards removing hyphens after prefixes
like "non-" etc.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-01-16 16:40:55 +00:00
|
|
|
When \fImode\fP is nonzero, the
|
2007-05-12 09:06:04 +00:00
|
|
|
.BR fwide ()
|
|
|
|
|
function first attempts to set
|
2008-07-09 15:33:56 +00:00
|
|
|
\fIstream\fP's orientation (to wide-character oriented
|
|
|
|
|
if \fImode\fP is greater than 0, or
|
|
|
|
|
to byte oriented if \fImode\fP is less than 0).
|
2007-04-12 22:42:49 +00:00
|
|
|
It then returns a value denoting the
|
2004-11-03 13:51:07 +00:00
|
|
|
current orientation, as above.
|
|
|
|
|
.SH "RETURN VALUE"
|
2007-05-12 09:06:04 +00:00
|
|
|
The
|
|
|
|
|
.BR fwide ()
|
|
|
|
|
function returns the stream's orientation, after possibly
|
2007-04-12 22:42:49 +00:00
|
|
|
changing it.
|
2008-07-09 15:22:08 +00:00
|
|
|
A positive return value means wide-character oriented.
|
|
|
|
|
A negative return value means byte oriented.
|
2007-04-12 22:42:49 +00:00
|
|
|
A return value of zero means undecided.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "CONFORMING TO"
|
2006-09-04 09:09:37 +00:00
|
|
|
C99, POSIX.1-2001.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH NOTES
|
|
|
|
|
Wide-character output to a byte oriented stream can be performed through the
|
2007-05-12 09:06:04 +00:00
|
|
|
.BR fprintf (3)
|
2007-07-09 21:02:59 +00:00
|
|
|
function with the
|
|
|
|
|
.B %lc
|
|
|
|
|
and
|
|
|
|
|
.B %ls
|
|
|
|
|
directives.
|
2004-11-03 13:51:07 +00:00
|
|
|
.PP
|
|
|
|
|
Char oriented output to a wide-character oriented stream can be performed
|
2007-05-12 09:06:04 +00:00
|
|
|
through the
|
|
|
|
|
.BR fwprintf (3)
|
2007-07-09 21:02:59 +00:00
|
|
|
function with the
|
|
|
|
|
.B %c
|
|
|
|
|
and
|
|
|
|
|
.B %s
|
|
|
|
|
directives.
|
2007-05-16 18:25:50 +00:00
|
|
|
.SH "SEE ALSO"
|
|
|
|
|
.BR fprintf (3),
|
|
|
|
|
.BR fwprintf (3)
|