summaryrefslogtreecommitdiff
path: root/autoopts/streqvmap.3
blob: a4c35186de5339f1dc3a237820aebd13970fd77d (plain)
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
36
37
38
39
40
41
42
43
44
45
46
47
48
.TH streqvmap 3 2012-08-11 "" "Programmer's Manual"
.\"  DO NOT EDIT THIS FILE   (streqvmap.3)
.\"  
.\"  It has been AutoGen-ed  August 11, 2012 at 09:44:56 AM by AutoGen 5.16.2
.\"  From the definitions    ./funcs.def
.\"  and the template file   agman3.tpl
.SH NAME
streqvmap - Set the character mappings for the streqv functions
.sp 1
.SH SYNOPSIS

#include <\fIyour-opts.h\fP>
.br
cc [...] -o outfile infile.c -l\fBopts\fP [...]
.sp 1
void \fBstreqvmap\fP(char \fIFrom\fP, char \fITo\fP, int \fIct\fP);
.sp 1
.SH DESCRIPTION
Set the character mapping.  If the count (\fBct\fP) is set to zero, then
the map is cleared by setting all entries in the map to their index
value.  Otherwise, the "\fBFrom\fP" character is mapped to the "\fBTo\fP"
character.  If \fBct\fP is greater than 1, then \fBFrom\fP and \fBTo\fP
are incremented and the process repeated until \fBct\fP entries have been
set. For example,
.nf
    streqvmap('a', 'A', 26);
.fi
will alter the mapping so that all English lower case letters
will map to upper case.

This function name is mapped to option_streqvmap so as to not conflict
with the POSIX name space.
.TP
.IR From
Input character
.TP
.IR To
Mapped-to character
.TP
.IR ct
compare length
.sp 1
.SH ERRORS
none.
.SH SEE ALSO
The \fIinfo\fP documentation for the -l\fIopts\fP library.
.br
ao_string_tokenize(3), configFileLoad(3), optionFileLoad(3), optionFindNextValue(3), optionFindValue(3), optionFree(3), optionGetValue(3), optionLoadLine(3), optionNextValue(3), optionOnlyUsage(3), optionProcess(3), optionRestore(3), optionSaveFile(3), optionSaveState(3), optionUnloadNested(3), optionVersion(3), pathfind(3), strequate(3), streqvcmp(3), strneqvcmp(3), strtransform(3),