Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://unicode-org.github.io/icu-docs/apidoc/released/icu4c/ustdio_8h.html below:

ICU 77.1: io/unicode/ustdio.h File Reference

C API: Unicode stdio-like API. More...

Go to the source code of this file.

C API: Unicode stdio-like API.

This API provides an stdio-like API wrapper around ICU's other formatting and parsing APIs. It is meant to ease the transition of adding Unicode support to a preexisting applications using stdio. The following is a small list of noticeable differences between stdio and ICU I/O's ustdio implementation.

• Locale specific formatting and parsing is only done with file IO.
• u_fstropen can be used to simulate file IO with strings. This is similar to the iostream API, and it allows locale specific formatting and parsing to be used.
• This API provides uniform formatting and parsing behavior between platforms (unlike the standard stdio implementations found on various platforms).
• This API is better suited for text data handling than binary data handling when compared to the typical stdio implementation.
• You can specify a Transliterator while using the file IO.
• You can specify a file's codepage separately from the default system codepage.

General printf format:
%[format modifier][width][.precision][type modifier][format]

General scanf format:
%[*][format modifier][width][type modifier][format]

Format modifiers

printf modifier %* int32_t Next argument after this one specifies the width

scanf modifier %* N/A This field is scanned, but not stored

If you are using this C API instead of the ustream.h API for C++, you can use one of the following u_fprintf examples to display a UnicodeString.

    UFILE *out = u_finit(stdout, NULL, NULL);
    UnicodeString string1("string 1");
    UnicodeString string2("string 2");
    u_fprintf(out, "%S\n", string1.getTerminatedBuffer());
    u_fprintf(out, "%.*S\n", string2.length(), string2.getBuffer());
    u_fclose(out);

Definition in file ustdio.h.

When an end of file is encountered, this value can be returned.

See also

u_fgetc

Stable:

3.0

Definition at line 212 of file ustdio.h.

Forward declaration of a Unicode-aware file.

Stable:

3.0

Definition at line 1 of file ustdio.h.

Open a UFILE on top of an existing FILE* stream.

The FILE* stream ownership is transferred to the new UFILE. It will be closed when the UFILE is closed.

Parameters

f The FILE* which this UFILE will take ownership of. locale The locale whose conventions will be used to format and parse output. If this parameter is NULL, the default locale will be used. codepage The codepage in which data will be written to and read from the file. If this parameter is NULL, data will be written and read using the default codepage for locale, unless locale is NULL, in which case the system default codepage will be used.

Returns

A new UFILE, or NULL if an error occurred. If an error occurs the ownership of the FILE* stream remains with the caller.

Stable:

ICU 4.4

Close a UFILE.

Implies u_fflush first.

Parameters

Stable:

ICU 3.0

See also

u_fflush

Tests if the UFILE is at the end of the file stream.

Parameters

f The UFILE from which to read.

Returns

Returns true after the first read operation that attempts to read past the end of the file. It returns false if the current position is not end of file.

Stable:

ICU 3.0

Flush output of a UFILE.

Implies a flush of converter/transliterator state. (That is, a logical break is made in the output stream - for example if a different type of output is desired.) The underlying OS level file is also flushed. Note that for a stateful encoding, the converter may write additional bytes to return the stream to default state.

Parameters

Stable:

ICU 3.0

Read a UChar from a UFILE.

It is recommended that u_fgetcx used instead for proper parsing functions, but sometimes reading code units is needed instead of codepoints.

Parameters

f The UFILE from which to read.

Returns

The UChar value read, or U+FFFF if no character was available.

Stable:

ICU 3.0

Get the codepage in which data is written to and read from the UFILE.

This is the same codepage passed in the preceding call to u_fsetcodepage or u_fopen.

Parameters

Returns

The codepage in which data is written to and read from the UFILE, or NULL if an error occurred.

Stable:

ICU 3.0

Returns an alias to the converter being used for this file.

Parameters

f The UFILE to get the value from

Returns

alias to the converter (The converter must not be modified or closed)

Stable:

ICU 3.0

Read a UChar32 from a UFILE.

Parameters

f The UFILE from which to read.

Returns

The UChar32 value read, or U_EOF if no character was available, or U+FFFD (replacement character) if an ill-formed character was encountered.

See also

u_unescape()

Stable:

ICU 3.0

Get the FILE* associated with a UFILE.

Parameters

Returns

A FILE*, owned by the UFILE. (The FILE must not be modified or closed)

Stable:

ICU 3.0

Get the locale whose conventions are used to format and parse output.

This is the same locale passed in the preceding call tou_fsetlocale or u_fopen.

Parameters

Returns

The locale whose conventions are used to format and parse output.

Stable:

ICU 3.0

Returns an alias to the number formatter being used for this file.

Parameters

f The UFILE to get the value from

Returns

alias to the number formatter (The formatter must not be modified or closed)

Stable:

ICU 51

Read one line of text into a UChar* string from a UFILE.

The newline at the end of the line is read into the string. The string is always null terminated

Parameters

f The UFILE from which to read. n The maximum number of characters - 1 to read. s The UChar* to receive the read data. Characters will be stored successively in s until a newline or EOF is reached. A null character (U+0000) will be appended to s.

Returns

A pointer to s, or NULL if no characters were available.

Stable:

ICU 3.0

Read Unicode from a UFILE.

Bytes will be converted from the UFILE's underlying codepage, with subsequent conversion to Unicode. The data will not be NULL terminated.

Parameters

chars A pointer to receive the Unicode data. count The number of Unicode characters to read. f The UFILE from which to read.

Returns

The number of Unicode characters read.

Stable:

ICU 3.0

Write Unicode to a UFILE.

The ustring passed in will be converted to the UFILE's underlying codepage before it is written.

Parameters

ustring A pointer to the Unicode data to write. count The number of Unicode characters to write f The UFILE to which to write.

Returns

The number of Unicode characters written.

See also

u_fputs

Stable:

ICU 3.0

Open a UFILE on top of an existing FILE* stream.

The FILE* stream ownership remains with the caller. To have the UFILE take over ownership and responsibility for the FILE* stream, use the function u_fadopt.

Parameters

f The FILE* to which this UFILE will attach and use. locale The locale whose conventions will be used to format and parse output. If this parameter is NULL, the default locale will be used. codepage The codepage in which data will be written to and read from the file. If this parameter is NULL, data will be written and read using the default codepage for locale, unless locale is NULL, in which case the system default codepage will be used.

Returns

A new UFILE, or NULL if an error occurred.

Stable:

ICU 3.0

Open a UFILE.

A UFILE is a wrapper around a FILE* that is locale and codepage aware. That is, data written to a UFILE will be formatted using the conventions specified by that UFILE's Locale; this data will be in the character set specified by that UFILE's codepage.

Parameters

filename The name of the file to open. Must be 0-terminated. perm The read/write permission for the UFILE; one of "r", "w", "rw" locale The locale whose conventions will be used to format and parse output. If this parameter is NULL, the default locale will be used. codepage The codepage in which data will be written to and read from the file. If this parameter is NULL the system default codepage will be used.

Returns

A new UFILE, or NULL if an error occurred.

Stable:

ICU 3.0

Open a UFILE with a UChar* filename A UFILE is a wrapper around a FILE* that is locale and codepage aware.

That is, data written to a UFILE will be formatted using the conventions specified by that UFILE's Locale; this data will be in the character set specified by that UFILE's codepage.

Parameters

filename The name of the file to open. Must be 0-terminated. perm The read/write permission for the UFILE; one of "r", "w", "rw" locale The locale whose conventions will be used to format and parse output. If this parameter is NULL, the default locale will be used. codepage The codepage in which data will be written to and read from the file. If this parameter is NULL the system default codepage will be used.

Returns

A new UFILE, or NULL if an error occurred.

Stable:

ICU 54

Write formatted data to a UFILE.

Parameters

f The UFILE to which to write. patternSpecification A pattern specifying how u_fprintf will interpret the variable arguments received and format the data.

Returns

The number of Unicode characters written to f.

Stable:

ICU 3.0

Write formatted data to a UFILE.

Parameters

f The UFILE to which to write. patternSpecification A pattern specifying how u_fprintf will interpret the variable arguments received and format the data.

Returns

The number of Unicode characters written to f.

Stable:

ICU 3.0

Write a UChar to a UFILE.

Parameters

uc The UChar to write. f The UFILE to which to write.

Returns

The character written if successful, EOF otherwise.

Stable:

ICU 3.0

Write a Unicode to a UFILE.

The null (U+0000) terminated UChar* s will be written to f, excluding the NULL terminator. A newline will be added to f.

Parameters

s The UChar* to write. f The UFILE to which to write.

Returns

A non-negative number if successful, EOF otherwise.

See also

u_file_write

Stable:

ICU 3.0

Rewind the file pointer to the beginning of the file.

Parameters

file The UFILE to rewind.

Stable:

ICU 3.0

Read formatted data from a UFILE.

Parameters

f The UFILE from which to read. patternSpecification A pattern specifying how u_fscanf will interpret the variable arguments received and parse the data.

Returns

The number of items successfully converted and assigned, or EOF if an error occurred.

Stable:

ICU 3.0

Read formatted data from a UFILE.

Parameters

f The UFILE from which to read. patternSpecification A pattern specifying how u_fscanf will interpret the variable arguments received and parse the data.

Returns

The number of items successfully converted and assigned, or EOF if an error occurred.

Stable:

ICU 3.0

Set the codepage in which data will be written to and read from the UFILE.

All Unicode data written to the UFILE will be converted to this codepage before it is written to the underlying FILE*. It it generally a bad idea to mix codepages within a file. This should only be called right after opening the UFile, or after calling u_frewind.

Parameters

codepage The codepage in which data will be written to and read from the file. For example "latin-1" or "ibm-943". A value of NULL means the default codepage for the UFILE's current locale will be used. file The UFILE to set.

Returns

0 if successful, otherwise a negative number.

See also

u_frewind

Stable:

ICU 3.0

Set the locale whose conventions will be used to format and parse output.

Parameters

locale The locale whose conventions will be used to format and parse output. file The UFILE to query.

Returns

NULL if successful, otherwise a negative number.

Stable:

ICU 3.0

Set a transliterator on the UFILE.

The transliterator will be owned by the UFILE.

Parameters

file The UFILE to set transliteration on adopt The UTransliterator to set. Can be NULL, which will mean that no transliteration is used. direction either U_READ, U_WRITE, or U_READWRITE - sets which direction the transliterator is to be applied to. If U_READWRITE, the "Read" transliteration will be in the inverse direction. status ICU error code.

Returns

The previously set transliterator, owned by the caller. If U_READWRITE is specified, only the WRITE transliterator is returned. In most cases, the caller should call utrans_close() on the result of this function.

Stable:

ICU 3.0

Create a UFILE that can be used for localized formatting or parsing.

The u_sprintf and u_sscanf functions do not read or write numbers for a specific locale. The ustdio.h file functions can be used on this UFILE. The string is usable once u_fclose or u_fflush has been called on the returned UFILE.

Parameters

stringBuf The string used for reading or writing. capacity The number of code units available for use in stringBuf locale The locale whose conventions will be used to format and parse output. If this parameter is NULL, the default locale will be used.

Returns

A new UFILE, or NULL if an error occurred.

Stable:

ICU 3.0

Unget a UChar from a UFILE.

If this function is not the first to operate on f after a call to u_fgetc, the results are undefined. If this function is passed a character that was not received from the previous u_fgetc or u_fgetcx call, the results are undefined.

Parameters

c The UChar to put back on the stream. f The UFILE to receive c.

Returns

The UChar32 value put back if successful, U_EOF otherwise.

Stable:

ICU 3.0

Get a UFILE for stdout.

Returns

UFILE that writes to stdout

Stable:

ICU 49

Write formatted data to stdout.

Parameters

patternSpecification A pattern specifying how u_printf will interpret the variable arguments received and format the data.

Returns

The number of Unicode characters written to stdout

Stable:

ICU 49

Write formatted data to stdout.

Parameters

patternSpecification A pattern specifying how u_printf_u will interpret the variable arguments received and format the data.

Returns

The number of Unicode characters written to stdout

Stable:

ICU 49

Write formatted data to a Unicode string.

When the number of code units required to store the data exceeds count, then count code units of data are stored in buffer and a negative value is returned. When the number of code units required to store the data equals count, the string is not null terminated and count is returned.

Parameters

buffer The Unicode String to which to write. count The number of code units to read. patternSpecification A pattern specifying how u_sprintf will interpret the variable arguments received and format the data.

Returns

The number of Unicode characters that would have been written to buffer had count been sufficiently large. This does not include the terminating null character.

Stable:

ICU 3.0

Write formatted data to a Unicode string.

When the number of code units required to store the data exceeds count, then count code units of data are stored in buffer and a negative value is returned. When the number of code units required to store the data equals count, the string is not null terminated and count is returned.

Parameters

buffer The Unicode string to which to write. count The number of code units to read. patternSpecification A pattern specifying how u_sprintf will interpret the variable arguments received and format the data.

Returns

The number of Unicode characters that would have been written to buffer had count been sufficiently large.

Stable:

ICU 3.0

Write formatted data to a Unicode string.

Parameters

buffer The Unicode String to which to write. patternSpecification A pattern specifying how u_sprintf will interpret the variable arguments received and format the data.

Returns

The number of Unicode code units written to buffer. This does not include the terminating null character.

Stable:

ICU 3.0

Write formatted data to a Unicode string.

Parameters

buffer The Unicode string to which to write. patternSpecification A pattern specifying how u_sprintf will interpret the variable arguments received and format the data.

Returns

The number of Unicode characters written to buffer.

Stable:

ICU 3.0

Read formatted data from a Unicode string.

Parameters

buffer The Unicode string from which to read. patternSpecification A pattern specifying how u_sscanf will interpret the variable arguments received and parse the data.

Returns

The number of items successfully converted and assigned, or EOF if an error occurred.

Stable:

ICU 3.0

Read formatted data from a Unicode string.

Parameters

buffer The Unicode string from which to read. patternSpecification A pattern specifying how u_sscanf will interpret the variable arguments received and parse the data.

Returns

The number of items successfully converted and assigned, or EOF if an error occurred.

Stable:

ICU 3.0

Write formatted data to a UFILE.

This is identical to u_fprintf, except that it will not call va_start and va_end.

Parameters

f The UFILE to which to write. patternSpecification A pattern specifying how u_fprintf will interpret the variable arguments received and format the data. ap The argument list to use.

Returns

The number of Unicode characters written to f.

See also

u_fprintf

Stable:

ICU 3.0

Write formatted data to a UFILE.

This is identical to u_fprintf_u, except that it will not call va_start and va_end.

Parameters

f The UFILE to which to write. patternSpecification A pattern specifying how u_fprintf will interpret the variable arguments received and format the data. ap The argument list to use.

Returns

The number of Unicode characters written to f.

See also

u_fprintf_u

Stable:

ICU 3.0

Read formatted data from a UFILE.

This is identical to u_fscanf, except that it will not call va_start and va_end.

Parameters

f The UFILE from which to read. patternSpecification A pattern specifying how u_fscanf will interpret the variable arguments received and parse the data. ap The argument list to use.

Returns

The number of items successfully converted and assigned, or EOF if an error occurred.

See also

u_fscanf

Stable:

ICU 3.0

Read formatted data from a UFILE.

This is identical to u_fscanf_u, except that it will not call va_start and va_end.

Parameters

f The UFILE from which to read. patternSpecification A pattern specifying how u_fscanf will interpret the variable arguments received and parse the data. ap The argument list to use.

Returns

The number of items successfully converted and assigned, or EOF if an error occurred.

See also

u_fscanf_u

Stable:

ICU 3.0

Write formatted data to a Unicode string.

This is identical to u_snprintf, except that it will not call va_start and va_end.

When the number of code units required to store the data exceeds count, then count code units of data are stored in buffer and a negative value is returned. When the number of code units required to store the data equals count, the string is not null terminated and count is returned.

Parameters

buffer The Unicode string to which to write. count The number of code units to read. patternSpecification A pattern specifying how u_sprintf will interpret the variable arguments received and format the data. ap The argument list to use.

Returns

The number of Unicode characters that would have been written to buffer had count been sufficiently large.

See also

u_sprintf

Stable:

ICU 3.0

Write formatted data to a Unicode string.

This is identical to u_snprintf_u, except that it will not call va_start and va_end. When the number of code units required to store the data exceeds count, then count code units of data are stored in buffer and a negative value is returned. When the number of code units required to store the data equals count, the string is not null terminated and count is returned.

Parameters

buffer The Unicode string to which to write. count The number of code units to read. patternSpecification A pattern specifying how u_sprintf will interpret the variable arguments received and format the data. ap The argument list to use.

Returns

The number of Unicode characters that would have been written to f had count been sufficiently large.

See also

u_sprintf_u

Stable:

ICU 3.0

Write formatted data to a Unicode string.

This is identical to u_sprintf, except that it will not call va_start and va_end.

Parameters

buffer The Unicode string to which to write. patternSpecification A pattern specifying how u_sprintf will interpret the variable arguments received and format the data. ap The argument list to use.

Returns

The number of Unicode characters written to buffer.

See also

u_sprintf

Stable:

ICU 3.0

Write formatted data to a Unicode string.

This is identical to u_sprintf_u, except that it will not call va_start and va_end.

Parameters

buffer The Unicode string to which to write. patternSpecification A pattern specifying how u_sprintf will interpret the variable arguments received and format the data. ap The argument list to use.

Returns

The number of Unicode characters written to f.

See also

u_sprintf_u

Stable:

ICU 3.0

Read formatted data from a Unicode string.

This is identical to u_sscanf, except that it will not call va_start and va_end.

Parameters

buffer The Unicode string from which to read. patternSpecification A pattern specifying how u_sscanf will interpret the variable arguments received and parse the data. ap The argument list to use.

Returns

The number of items successfully converted and assigned, or EOF if an error occurred.

See also

u_sscanf

Stable:

ICU 3.0

Read formatted data from a Unicode string.

This is identical to u_sscanf_u, except that it will not call va_start and va_end.

Parameters

buffer The Unicode string from which to read. patternSpecification A pattern specifying how u_sscanf will interpret the variable arguments received and parse the data. ap The argument list to use.

Returns

The number of items successfully converted and assigned, or EOF if an error occurred.

See also

u_sscanf_u

Stable:

ICU 3.0

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4