]> git.wh0rd.org - fontconfig.git/blame - doc/fcvalue.fncs
Cleanup copyright notices to replace "Keith Packard" with "the author(s)"
[fontconfig.git] / doc / fcvalue.fncs
CommitLineData
bfc2dc3a 1/*
e690fbb2 2 * fontconfig/doc/fcvalue.fncs
bfc2dc3a 3 *
46b51147 4 * Copyright © 2003 Keith Packard
bfc2dc3a
KP
5 *
6 * Permission to use, copy, modify, distribute, and sell this software and its
7 * documentation for any purpose is hereby granted without fee, provided that
8 * the above copyright notice appear in all copies and that both that
9 * copyright notice and this permission notice appear in supporting
5aaf466d 10 * documentation, and that the name of the author(s) not be used in
bfc2dc3a 11 * advertising or publicity pertaining to distribution of the software without
5aaf466d 12 * specific, written prior permission. The authors make no
bfc2dc3a
KP
13 * representations about the suitability of this software for any purpose. It
14 * is provided "as is" without express or implied warranty.
15 *
3074a73b 16 * THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
bfc2dc3a 17 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
3074a73b 18 * EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
bfc2dc3a
KP
19 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
20 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
21 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
22 * PERFORMANCE OF THIS SOFTWARE.
23 */
22671e25
KP
24@RET@ void
25@FUNC@ FcValueDestroy
61895ed1 26@TYPE1@ FcValue% @ARG1@ v
22671e25
KP
27@PURPOSE@ Free a value
28@DESC@
2df0c662 29Frees any memory referenced by <parameter>v</parameter>. Values of type FcTypeString,
22671e25
KP
30FcTypeMatrix and FcTypeCharSet reference memory, the other types do not.
31@@
32
33@RET@ FcValue
34@FUNC@ FcValueSave
61895ed1 35@TYPE1@ FcValue% @ARG1@ v
22671e25
KP
36@PURPOSE@ Copy a value
37@DESC@
2df0c662 38Returns a copy of <parameter>v</parameter> duplicating any object referenced by it so that <parameter>v</parameter>
22671e25
KP
39may be safely destroyed without harming the new value.
40@@
a190678e
KP
41
42@RET@ void
43@FUNC@ FcValuePrint
44@TYPE1@ FcValue% @ARG1@ v
45@PURPOSE@ Print a value to stdout
46@DESC@
47Prints a human-readable representation of <parameter>v</parameter> to
48stdout. The format should not be considered part of the library
49specification as it may change in the future.
50@@
51
52@RET@ FcBool
53@FUNC@ FcValueEqual
54@TYPE1@ FcValue% @ARG1@ v_a
55@TYPE2@ FcValue% @ARG2@ v_b
56@PURPOSE@ Test two values for equality
57@DESC@
58Compares two values. Integers and Doubles are compared as numbers; otherwise
59the two values have to be the same type to be considered equal. Strings are
60compared ignoring case.
61@@