Manual Pages for UNIX Darwin command on man wprintf

WPRINTF(3) BSD Library Functions Manual WPRINTF(3)

NAME

wwpprriinnttff, ffwwpprriinnttff, sswwpprriinnttff, vvwwpprriinnttff, vvffwwpprriinnttff, vvsswwpprriinnttff - formatted

wide character output conversion LLIIBBRRAARRYY

Standard C Library (libc, -lc)

SYNOPSIS

##iinncclluuddee <>

int ffwwpprriinnttff(FILE * restrict stream, const wchart * restrict format, ...); int sswwpprriinnttff(wchart * restrict ws, sizet n, const wchart * restrict format, ...); int wwpprriinnttff(const wchart * restrict format, ...);

##iinncclluuddee <>

int vvffwwpprriinnttff(FILE * restrict stream, const wchart * restrict, valist ap); int vvsswwpprriinnttff(wchart * restrict ws, sizet n, const wchart *restrict format, valist ap); int vvwwpprriinnttff(const wchart * restrict format, valist ap);

DESCRIPTION

The wwpprriinnttff() family of functions produces output according to a format as described below. The wwpprriinnttff() and vvwwpprriinnttff() functions write output to stdout, the standard output stream; ffwwpprriinnttff() and vvffwwpprriinnttff() write output to the given output stream; sswwpprriinnttff() and vvsswwpprriinnttff() write to the wide character string ws. Extended locale versions of these functions are documented in

wprintfl(3). See xlocale(3) for more information.

These functions write the output under the control of a format string that specifies how subsequent arguments (or arguments accessed via the

variable-length argument facilities of stdarg(3)) are converted for out-

put. These functions return the number of characters printed (not including the trailing `\0' used to end output to strings). The sswwpprriinnttff() and vvsswwpprriinnttff() functions will fail if n or more wide characters were requested to be written,

The format string is composed of zero or more directives: ordinary char-

acters (not %%), which are copied unchanged to the output stream; and con-

version specifications, each of which results in fetching zero or more subsequent arguments. Each conversion specification is introduced by the

%% character. The arguments must correspond properly (after type promo-

tion) with the conversion specifier. After the %%, the following appear

in sequence: ++oo An optional field, consisting of a decimal digit string followed by a

$$, specifying the next argument to access. If this field is not pro-

vided, the argument following the last argument accessed will be used. Arguments are numbered starting at 11. If unaccessed arguments in the format string are interspersed with ones that are accessed the results will be indeterminate. ++oo Zero or more of the following flags:

`##' The value should be converted to an ``alternate form''.

For cc, dd, ii, nn, pp, ss, and uu conversions, this option has

no effect. For oo conversions, the precision of the num-

ber is increased to force the first character of the output string to a zero (except if a zero value is printed with an explicit precision of zero). For xx and

XX conversions, a non-zero result has the string `0x' (or

`0X' for XX conversions) prepended to it. For aa, AA, ee, EE, ff, FF, gg, and GG conversions, the result will always contain a decimal point, even if no digits follow it (normally, a decimal point appears in the results of those conversions only if a digit follows). For gg and GG conversions, trailing zeros are not removed from the result as they would otherwise be.

`00' (zero) Zero padding. For all conversions except nn, the con-

verted value is padded on the left with zeros rather than blanks. If a precision is given with a numeric conversion (dd, ii, oo, uu, ii, xx, and XX), the 00 flag is ignored.

`-' A negative field width flag; the converted value is to

be left adjusted on the field boundary. Except for nn conversions, the converted value is padded on the right with blanks, rather than on the left with blanks or

zeros. A - overrides a 00 if both are given.

` ' (space) A blank should be left before a positive number produced by a signed conversion (aa, AA, dd, ee, EE, ff, FF, gg, GG, or ii). `++' A sign must always be placed before a number produced by a signed conversion. A ++ overrides a space if both are used. `''' Decimal conversions (dd, uu, or ii) or the integral portion of a floating point conversion (ff or FF) should be

grouped and separated by thousands using the non-mone-

tary separator returned by localeconv(3).

++oo An optional separator character ( ,, | ;; | :: | ) used for separat-

ing multiple values when printing an AltiVec vector, or other multi-

value unit.

NOTE: This is an AltiVec only extension onto the pprriinnttff() specifica-

tion. Behaviour of these values for pprriinnttff() is only defined for operating systems conforming to the AltiVec Technology Programming Interface Manual. (At time of writing this includes only Mac OS X 10.2 and later.) ++oo An optional decimal digit string specifying a minimum field width. If the converted value has fewer characters than the field width, it

will be padded with spaces on the left (or right, if the left-adjust-

ment flag has been given) to fill out the field width. ++oo An optional precision, in the form of a period .. followed by an optional digit string. If the digit string is omitted, the precision is taken as zero. This gives the minimum number of digits to appear for dd, ii, oo, uu, xx, and XX conversions, the number of digits to appear

after the decimal-point for aa, AA, ee, EE, ff, and FF conversions, the

maximum number of significant digits for gg and GG conversions, or the

maximum number of characters to be printed from a string for ss con-

versions. ++oo An optional length modifier, that specifies the size of the argument. The following length modifiers are valid for the dd, ii, nn, oo, uu, xx, or XX conversion: MMooddiiffiieerr dd, ii oo, uu, xx, XX nn hhhh signed char unsigned char signed char * hh short unsigned short short * ll (ell) long unsigned long long * llll (ell ell) long long unsigned long long long long * jj intmaxt uintmaxt intmaxt * tt ptrdifft (see note) ptrdifft * zz (see note) sizet (see note) qq (deprecated) quadt uquadt quadt * Note: the tt modifier, when applied to a oo, uu, xx, or XX conversion, indicates that the argument is of an unsigned type equivalent in size to a ptrdifft. The zz modifier, when applied to a dd or ii conversion, indicates that the argument is of a signed type equivalent in size to a sizet. Similarly, when applied to an nn conversion, it indicates that the argument is a pointer to a signed type equivalent in size to a sizet. The following length modifier is valid for the aa, AA, ee, EE, ff, FF, gg, or GG conversion: MMooddiiffiieerr aa, AA, ee, EE, ff, FF, gg, GG LL long double The following length modifier is valid for the cc or ss conversion: MMooddiiffiieerr cc ss ll (ell) wintt wchart * The AltiVec Technology Programming Interface Manual also defines five

additional length modifiers which can be used (in place of the con-

ventional length modifiers) for the printing of AltiVec vectors: vv Treat the argument as a vector value, unit length will be determined by the conversion specifier (default = 16

8-bit units for all integer conversions, 4 32-bit units

for floating point conversions).

vvhh,, hhvv Treat the argument as a vector of 8 16-bit units.

vvll,, llvv Treat the argument as a vector of 4 32-bit units.

NOTE: The vector length specifiers are AltiVec only extensions onto

the pprriinnttff() specification. Behaviour of these values for pprriinnttff()

is only defined for operating systems conforming to the AltiVec Tech-

nology Programming Interface Manual. (At time of writing this includes only Mac OS X 10.2 and later.) ++oo A character that specifies the type of conversion to be applied. A field width or precision, or both, may be indicated by an asterisk `*'

or an asterisk followed by one or more decimal digits and a `$' instead

of a digit string. In this case, an int argument supplies the field

width or precision. A negative field width is treated as a left adjust-

ment flag followed by a positive field width; a negative precision is treated as though it were missing. If a single format directive mixes

positional (nn$) and non-positional arguments, the results are undefined.

The conversion specifiers and their meanings are: ddiioouuxxXX The int (or appropriate variant) argument is converted to signed decimal (dd and ii), unsigned octal (oo), unsigned decimal (uu), or unsigned hexadecimal (xx and XX) notation. The letters ``abcdef'' are used for xx conversions; the letters ``ABCDEF'' are used for XX conversions. The precision, if any, gives the minimum number of digits that must appear; if the converted value requires fewer digits, it is padded on the left with zeros. DDOOUU The long int argument is converted to signed decimal, unsigned octal, or unsigned decimal, as if the format had been lldd, lloo, or lluu respectively. These conversion characters are deprecated, and will eventually disappear. eeEE The double argument is rounded and converted in the style

[-]d.ddde+-dd where there is one digit before the decimal-point

character and the number of digits after it is equal to the pre-

cision; if the precision is missing, it is taken as 6; if the

precision is zero, no decimal-point character appears. An EE con-

version uses the letter `E' (rather than `e') to introduce the exponent. The exponent always contains at least two digits; if the value is zero, the exponent is 00. For aa, AA, ee, EE, ff, FF, gg, and GG conversions, positive and negative

infinity are represented as inf and -inf respectively when using

the lowercase conversion character, and INF and -INF respectively

when using the uppercase conversion character. Similarly, NaN is represented as nan when using the lowercase conversion, and NAN when using the uppercase conversion. ffFF The double argument is rounded and converted to decimal notation

in the style [-]ddd.ddd, where the number of digits after the

decimal-point character is equal to the precision specification.

If the precision is missing, it is taken as 6; if the precision

is explicitly zero, no decimal-point character appears. If a

decimal point appears, at least one digit appears before it. ggGG The double argument is converted in style ff or ee (or FF or EE for GG conversions). The precision specifies the number of significant digits. If the precision is missing, 6 digits are given; if the precision is zero, it is treated as 1. Style ee is used if the

exponent from its conversion is less than -4 or greater than or

equal to the precision. Trailing zeros are removed from the fractional part of the result; a decimal point appears only if it is followed by at least one digit. aaAA The double argument is converted to hexadecimal notation in the

style [-]0xh.hhhp[+-]d, where the number of digits after the

hexadecimal-point character is equal to the precision specifica-

tion. If the precision is missing, it is taken as enough to

exactly represent the floating-point number; if the precision is

explicitly zero, no hexadecimal-point character appears. This is

an exact conversion of the mantissa+exponent internal floating

point representation; the [-]0xh.hhh portion represents exactly

the mantissa; only denormalized mantissas have a zero value to the left of the hexadecimal point. The pp is a literal character `p'; the exponent is preceded by a positive or negative sign and

is represented in decimal, using only enough characters to repre-

sent the exponent. The AA conversion uses the prefix ``0X'' (rather than ``0x''), the letters ``ABCDEF'' (rather than ``abcdef'') to represent the hex digits, and the letter `P' (rather than `p') to separate the mantissa and exponent. CC Treated as cc with the ll (ell) modifier. cc The int argument is converted to an unsigned char, then to a

wchart as if by btowc(3), and the resulting character is writ-

ten. If the ll (ell) modifier is used, the wintt argument is converted to a wchart and written. SS Treated as ss with the ll (ell) modifier. ss The char * argument is expected to be a pointer to an array of character type (pointer to a string) containing a multibyte

sequence. Characters from the array are converted to wide char-

acters and written up to (but not including) a terminating NUL character; if a precision is specified, no more than the number

specified are written. If a precision is given, no null charac-

ter need be present; if the precision is not specified, or is

greater than the size of the array, the array must contain a ter-

minating NUL character. If the ll (ell) modifier is used, the wchart * argument is expected to be a pointer to an array of wide characters (pointer to a wide string). Each wide character in the string is written.

Wide characters from the array are written up to (but not includ-

ing) a terminating wide NUL character; if a precision is speci-

fied, no more than the number specified are written (including shift sequences). If a precision is given, no null character need be present; if the precision is not specified, or is greater

than the number of characters in the string, the array must con-

tain a terminating wide NUL character. pp The void * pointer argument is printed in hexadecimal (as if by

`%#x' or `%#lx').

nn The number of characters written so far is stored into the inte-

ger indicated by the int * (or variant) pointer argument. No argument is converted.

%% A `%' is written. No argument is converted. The complete con-

version specification is `%%'.

The decimal point character is defined in the program's locale (category LCNUMERIC).

In no case does a non-existent or small field width cause truncation of a

numeric field; if the result of a conversion is wider than the field width, the field is expanded to contain the conversion result. SSEECCUURRIITTYY CCOONNSSIIDDEERRAATTIIOONNSS Refer to printf(3).

wscanf(3), wprintfl(3)

STANDARDS

Subject to the caveats noted in the BUGS section of printf(3), the

wwpprriinnttff(), ffwwpprriinnttff(), sswwpprriinnttff(), vvwwpprriinnttff(), vvffwwpprriinnttff() and vvsswwpprriinnttff() functions conform to ISO/IEC 9899:1999 (``ISO C99''). BSD July 5, 2003 BSD