gem-graph-client/doc/rtfm/man3/strings_op.c.3

70 lines
2.6 KiB
Groff

.TH "src/util/strings_op.c" 3 "Version 0.1.0" "Gem-graph" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/util/strings_op.c \- concat
.SH SYNOPSIS
.br
.PP
\fC#include <stdlib\&.h>\fP
.br
\fC#include <stdarg\&.h>\fP
.br
\fC#include <string\&.h>\fP
.br
.SS "Functions"
.in +1c
.ti -1c
.RI "char * \fButil_concat\fP (const char *str,\&.\&.\&.)"
.br
.RI "https://sourceware.org/glibc/manual/latest/html_mono/libc.html#Variadic-Prototypes "
.in -1c
.SH "Detailed Description"
.PP
concat
This file is part of Gem-graph\&.
.PP
Programmers using the strcat function can easily be recognized as lazy and reckless\&. from The GNU C Library (glibc) manual (5\&.5 Concatenating Strings)
.PP
Whenever a programmer feels the need to use strcat she or he should think twice and look through the program to see whether the code cannot be rewritten to take advantage of already calculated results\&. The related functions strlcat, strncat, wcscat and wcsncat are almost always unnecessary, too\&. Again: it is almost always unnecessary to use functions like strcat\&. 😄️
.PP
Before calling vprintf or the other functions listed in this section, you must call va_start (see Variadic Functions) to initialize a pointer to the variable arguments\&. Then you can call va_arg to fetch the arguments that you want to handle yourself\&. This advances the pointer past those arguments\&.
.PP
Once your va_list pointer is pointing at the argument of your choice, you are ready to call vprintf\&. That argument and all subsequent arguments that were passed to your function are used by vprintf along with the template that you specified separately\&.
.PP
A\&.2 Variadic Functions ISO C defines a syntax for declaring a function to take a variable number or type of arguments\&. (Such functions are referred to as varargs functions or variadic functions\&.) However, the language itself provides no mechanism for such functions to access their non-required arguments; instead, you use the variable arguments macros defined in stdarg\&.h\&.
.PP
This section describes how to declare variadic functions, how to write them, and how to call them properly\&.
.SH "Function Documentation"
.PP
.SS "char * util_concat (const char * str, \&.\&.\&.)"
.PP
https://sourceware.org/glibc/manual/latest/html_mono/libc.html#Variadic-Prototypes
.PP
\fBSee also\fP
.RS 4
(in glibc/manual) > ellipsis (‘…’) A\&.2\&.2\&.2 Receiving the Argument Values
.RE
.PP
\fBParameters\fP
.RS 4
\fI*str\fP
.br
\fI\&.\&.\&.\fP
.RE
.PP
\fBReturns\fP
.RS 4
*
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for Gem-graph from the source code\&.