getwc.3c (2010 09)

ManualsBrandsHP ManualsSoftwareHP-UX Manpages

getwc(3C) getwc(3C)

NAME

getwc(), getwchar(), fgetwc() - get a wide character from a stream ﬁle

SYNOPSIS

#include <wchar.h>

wint_t getwc(FILE *stream);

wint_t getwchar(void);

wint_t fgetwc(FILE *stream);

Obsolescent Interfaces

wint_t getwc_unlocked(FILE *stream);

wint_t getwchar_unlocked(void);

wint_t fgetwc_unlocked(FILE *stream);

Remarks

These functions are compliant with the XPG4 Worldwide Portability Interface wide-character I/O func-

tions. They parallel the 8-bit character I/O functions deﬁned in getc (3S).

DESCRIPTION

getwc() Returns the next character from the named input stream , converts that to the

corresponding wide character and moves the ﬁle pointer ahead one character in stream .

getwchar() is deﬁned as getwc(stdin). getwc() and getwchar() are deﬁned

both as macros and as functions.

fgetwc() Behaves like getwc(), but is a function rather than a macro.

Deﬁnitions for these functions, the types

wint_t, wchar_t and the value WEOF are provided in header

ﬁle <wchar.h>.

Obsolescent Interfaces

getwc_unlocked(),

getwchar_unlocked(), fgetwc_unlocked()

get a wide character from a

stream ﬁle.

APPLICATION USAGE

After

getwc(), getwchar(),orfgetwc() is applied to a stream, the stream becomes wide-oriented

(see orientation (5)).

RETURN VALUE

Upon successful completion,

getwc(), getwc_unlocked()

, getwchar(),

getwchar_unlocked()

, fgetwc(), and fgetwc_unlocked() return the next wide-character

read from stream (

stdin for getwchar()) converted to a type wint_t. If the stream is at end-of-ﬁle,

the end-of-ﬁle indicator for the stream is set and WEOF is returned.

When the ﬁle corresponding to an open stream gets extended after the end-of-ﬁle is reached, any subse-

quent calls to these functions will succeed and the end-of-ﬁle indicator will remain set. However, in the

UNIX2003 standards environment (see standards (5)), these functions will return

WEOF and the end-of-

ﬁle indicator will still remain set.

If a read error occurs, the error indicator for the stream is set,

errno is set to indicate the error, and

WEOF is returned.

ferror() and feof() can be used to distinguish between an error condition and an end-of-ﬁle condi-

tion.

ERRORS

getwc(), getwc_unlocked(), getwchar(), getwchar_unlocked(), fgetwc(), and

fgetwc_unlocked() fail if data needs to be read into the stream ’s buffer, and:

[EAGAIN] The

O_NONBLOCK ﬂag is set for the ﬁle descriptor underlying stream and the process

would be delayed in the read operation.

[EBADF] The ﬁle descriptor underlying stream is not a valid ﬁle descriptor open for reading.

HP-UX 11i Version 3: September 2010 − 1 − Hewlett-Packard Company 1

Summary of content (2 pages)

PAGE 1
getwc(3C) getwc(3C) NAME getwc(), getwchar(), fgetwc() - get a wide character from a stream file SYNOPSIS #include wint_t getwc(FILE *stream); wint_t getwchar(void); wint_t fgetwc(FILE *stream); Obsolescent Interfaces wint_t getwc_unlocked(FILE *stream); wint_t getwchar_unlocked(void); wint_t fgetwc_unlocked(FILE *stream); Remarks These functions are compliant with the XPG4 Worldwide Portability Interface wide-character I/O functions.
PAGE 2
getwc(3C) getwc(3C) [EINTR] The read operation was terminated due to the receipt of a signal, and either no data was transferred or the implementation does not report partial transfer for this file. [EIO] A physical I/O error has occurred, or the process is a member of a background process and is attempting to read from its controlling terminal, and either the process is ignoring or blocking the SIGTTIN signal or the process group of the process is orphaned.