File: al_ustr_newf.3

package info (click to toggle)
allegro5 2%3A5.0.10-3
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 14,856 kB
  • ctags: 15,948
  • sloc: ansic: 87,540; cpp: 9,693; objc: 3,491; python: 2,057; sh: 829; makefile: 93; perl: 37; pascal: 24
file content (35 lines) | stat: -rw-r--r-- 1,011 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
.TH al_ustr_newf 3 "" "Allegro reference manual"
.SH NAME
.PP
al_ustr_newf \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro.h>

ALLEGRO_USTR\ *al_ustr_newf(const\ char\ *fmt,\ ...)
\f[]
.fi
.SH DESCRIPTION
.PP
Create a new string using a printf\-style format string.
.PP
\f[I]Notes:\f[]
.PP
The "%s" specifier takes C string arguments, not ALLEGRO_USTRs.
Therefore to pass an ALLEGRO_USTR as a parameter you must use
al_cstr(3), and it must be NUL terminated.
If the string contains an embedded NUL byte everything from that byte
onwards will be ignored.
.PP
The "%c" specifier outputs a single byte, not the UTF\-8 encoding of a
code point.
Therefore it is only usable for ASCII characters (value <= 127) or if
you really mean to output byte values from 128\-\-255.
To insert the UTF\-8 encoding of a code point, encode it into a memory
buffer using al_utf8_encode(3) then use the "%s" specifier.
Remember to NUL terminate the buffer.
.SH SEE ALSO
.PP
al_ustr_new(3), al_ustr_appendf(3)