File: al_ustr_insert.3

package info (click to toggle)
allegro5 2%3A5.2.6.0-3%2Bdeb11u1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 24,212 kB
  • sloc: ansic: 125,319; cpp: 15,781; objc: 4,579; python: 2,802; java: 2,254; javascript: 1,204; sh: 1,002; makefile: 51; perl: 37; xml: 25; pascal: 24
file content (33 lines) | stat: -rw-r--r-- 844 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
.\" Automatically generated by Pandoc 1.19.2.4
.\"
.TH "al_ustr_insert" "3" "" "Allegro reference manual" ""
.hy
.SH NAME
.PP
al_ustr_insert \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro.h>

bool\ al_ustr_insert(ALLEGRO_USTR\ *us1,\ int\ pos,\ const\ ALLEGRO_USTR\ *us2)
\f[]
.fi
.SH DESCRIPTION
.PP
Insert \f[C]us2\f[] into \f[C]us1\f[] beginning at byte offset
\f[C]pos\f[].
\f[C]pos\f[] cannot be less than 0.
If \f[C]pos\f[] is past the end of \f[C]us1\f[] then the space between
the end of the string and \f[C]pos\f[] will be padded with NUL
(\f[C]\[aq]\\0\[aq]\f[]) bytes.
.PP
If required, use al_ustr_offset(3) to find the byte offset for a given
code point index.
.PP
Returns true on success, false on error.
.SH SEE ALSO
.PP
al_ustr_insert_cstr(3), al_ustr_insert_chr(3), al_ustr_append(3),
al_ustr_offset(3)